Joomla! Documentation - User contributions [en]

Testing Joomla Extensions with Codeception

2015-11-01T10:53:56Z

THE AI: Selenium IDE and Codeception formatter

<nowiki>Note: this page is under construction</nowiki>

== What is Codeception? ==
Codeception PHP Testing Framework is designed to work just out of the box. This means its installation requires minimal steps and no external dependencies preinstalled (except PHP, of course). Only one configuration step should be taken and you are ready to test your web application from an eye of actual user.

See the following video of codeception in action testing Joomla:

{{#widget:YouTube|id=Vc1BJNnhsFM}}

=== Types of tests ===
Codeception provides possibilities to do Unit Testing or to Test APIs, however '''this page is focused in System Testing'''.

- '''System testing''' uses a production-like environment to verify the system as a whole, including user interfaces, databases, web servers, logging, etc.

- A '''unit test''' verifies a single behavior of a single unit – this can be a function, a method, or a class. A logical unit is something that can be reasoned about in isolation. The unit must be completely under your control. The test should limit the number of other units it touches on, and should not touch any part outside of your own system. As such, the test should only fail for one reason.

- '''Integration testing''' means we’re verifying that that different units are working together. It focuses on the interfaces between components. Some of these components may be from third parties. When they break, they signal that, although individual units may behave correctly, something changed in the API that caused failure in another place. Often, integration tests are slower than unit tests.

As mentioned at the beginning of this text, the current page is focused on '''System Tests''' and more specifically using Webdriver. The reason is that we came to the conclusion that this type of tests combined with the already existing Unit tests in Joomla are the most successful way to test our current code.

== Why Use Codeception? ==
''Why use Codeception when we already have Selenium IDE?''

Codeception works great with Selenium. But with Codeception you can write your tests in PHP. The main reason is: Selenium IDE tests are tightly bound to XPath locators. If you ever change anything in layout tests will fall. Codeception locators are more stable. You can use names, labels, button names and CSS to match elements on page.

'''Features'''
* Selenium WebDriver integration
* Elements matched by name, CSS, XPath
* PageObjects and StepObjects included
* Powered by PHPUnit
* Data Cleanup
* Parallel Execution of tests
* BDD-style readable tests

== Architecture of a test ==
The testing framework is built on the three layered testing architecture

=== Scenarios (Cept Class) ===
Cept or Test, it is the main class which contains steps of execution for the tests, Cept Class will call Step Class functions which will indirectly make use of page objects to perform operations

Example:
<source lang="php">
$I = new AcceptanceTester($scenario);
$I->wantTo('Install Joomla CMS');
$I->amOnPage('http://localhost/installation/index.php');
// I Wait for the text Main Configuration, meaning that the page is loaded
$I->waitForText('Main Configuration', 10, 'h3');
$I->click(JoomlaInstallationConfigurationPage::$elements['Language Selector']);
$I->click(JoomlaInstallationConfigurationPage::$elements['English (United Kingdom)']);
$I->fillField('Site Name', 'weblinks');
$I->fillField('Description', 'Site for testing Weblinks component');
$I->fillField('Admin Email', $cfg['Admin email']);
$I->fillField('Admin Username', $cfg['username']);
$I->fillField('Admin Password', $cfg['password']);
$I->fillField('Confirm Admin Password', $cfg['password']);
$I->click('Next');
...
</source>

=== Page Objects ===
Each page on your application has a class which we call page objects, each page class will have information about the URL, fields, Text present on the page. We use the best possible selector for any field on the page.

==== Example ====
<source lang="php">
class JoomlaAdministratorLoginManagerPage
{
/**
* @var string Url of the page
*/
public static $URL = '/administrator/index.php';

/**
* Array of Page elements indexed by descriptive name or label
*
* @var array
*/
public static $elements = array(
'username' => "#mod-login-username",
'password' => "#mod-login-password"
);
}
</source>

==== Naming convention for Page Objects ====
When this document is created Codeception 2.0 was not having a PSR-4 compatible autoloader. Therefore we are creating a convention so with the future Codeception 2.1 with PSR-4 compatible autoloader (https://github.com/Codeception/Codeception/pull/1228) we are creating a naming convention for Pages so it will cost us a small effort to move to autoloaded classes in the future.

The naming convention works as follows:

APPLICATION (for example Joomla, Patchtester, Weblinks or your Extension name)
+ CLIENT (in Joomla we use it for defining if is Installation, Administrator or Frontend
+ CLIENT PART (In Joomla we use it following the menu are were it belongs: Components, Menus, System,...)
+ PAGE NAME (The Page name)
+ Page

Examples:

JoomlaAdministratorLoginPage
JoomlaAdministratorSystemGlobalconfigurationPage
JoomlaInstallationConfigurationPage

And they are located with a folder estructure similar to:

[[File:System_tests_pages_folder_structure.png|framed|center|Folder estructure for Pages in System Tests]]

Remind that in Codeception 2.0 you need to specify each folder in the acceptance/_bootstrap.php file:
<source lang="php">
<?php
// Here you can initialize variables that will be available to your tests
\Codeception\Util\Autoload::registerSuffix('Page', __DIR__.DIRECTORY_SEPARATOR.'_pages/joomla/installation');
\Codeception\Util\Autoload::registerSuffix('Page', __DIR__.DIRECTORY_SEPARATOR.'_pages/joomla/administrator');
</source>

==== Documentation ====
More info: http://codeception.com/docs/07-AdvancedUsage#PageObjects

=== Step Objects ===
Step Objects are classes which contains steps which are to be executed on the application to perform certain operations, step objects make use of page objects to perform these actions.

Example:
<source lang="php">
class JoomlaAdministratorLoginSteps extends \AcceptanceTester
{
/**
* Function to execute an Admin Login for Joomla 3
*
* @return void
*/
public function doAdministratorLogin($user, $password)
{
$I = $this;
$I->amOnPage(\JoomlaAdministratorLoginPage::$URL);
$I->fillField(\JoomlaAdministratorLoginPage::$elements['username'], $user);
$I->fillField(\JoomlaAdministratorLoginPage::$elements['password'], $password);
$I->click('Log in');
$I->see('Category Manager');
}
}
</source>

More info: http://codeception.com/docs/07-AdvancedUsage#StepObjects

=== The Joomla Browser Module ===
The Joomla Browser is a Codeception Module that incorporates general functions to your tests like:
- do administrator login
- install joomla
- install extension
- ...

Find details about it at: https://github.com/joomla-projects/joomla-browser#table-of-contents

== Getting started from scratch: what you need to download and install ==
To get the test environment running you need to have several components installed.

'''Important note:''' no matter if you are executing [https://github.com/joomla/joomla-cms/tree/staging/tests/codeception#testing-joomla-cms Joomla CMS Tests], [https://github.com/joomla-extensions/weblinks#tests Weblinks], or tests in other Joomla extensions, in any case you are asked to fork the repository into your local machine under your htdocs folder of your local web-server. The reason is that, the automated scripts that launches the tests use the repository files for the tests.

=== local webserver ===
If you do not already have a local test server running you may want to check out:
https://www.mamp.info/
https://www.apachefriends.org/
http://www.ampps.com/

If you are not familiar with setting up a local web-server, learn that first before you advance futher.

=== Java Runtime Environment (JRE) ===
The JRE has to be installed, so the tests will be executable. You find the recent versions at the Oracle Website.
In end of May 2015 this is: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
later on that link could be obsolete and should be changed if there is a newer version out.

Newer Mac OS Versions are not shipped any more with the JRE, so they have to download that too.

=== Firefox ===
Selenium is testing in the browser Firefox. The selenium version is not that quick with the updates, as the Firefox browser, if the test is not executable, then it can be that you manually have to install an older version of Firefox.
Sadly that can be a try and error thing. To get older versions of Firefox: https://ftp.mozilla.org/pub/mozilla.org/firefox/releases/ here you will find many folders. Just try the first one that came before the Firefox version that you have been using (and that did not work). In the version folders you will find folders for all the different operating systems.

‎

=== configure test system variables ===

[[File:Acceptance.suite.dist.yml rename.png|thumbnail|left|Screenshot of file structure]]

In your the folder that you installed, downloaded, pulled (git) the project, you have to rename the "''acceptance.suite.dist.yml''" file to "''acceptance.suite.yml''" and configure the parameters to your system variables.
<source lang="php">
config:
JoomlaBrowser:
url: 'http://localhost/tests/joomla-cms3'
# the url that points to the joomla installation at /tests/system/joomla-cms
browser: 'firefox'
window_size: 1024x768
[...]
</source>
[[File:Run Command vendor bin robo test-acceptance.png|thumbnail|test:acceptance]]
Once your machine is able to run tests (see ''The Joomla Browser Module''), you are able to start working.

Check the contents of the /tests/ folder in weblinks and try to understand the structure of the tests.
For each function you have a directory and sometimes a configuration file, both will have the corresponding name.
* FunctionName.yml - these files contain configurations for the function folders
* FunctionName - contains the ''FunctionName'' test
* joomla-cms3 - contains the latest Joomla! installation

After that check the tasks are at: https://github.com/joomla-extensions/weblinks/issues/47

== The principles for writing a test: Readability and Performance ==
In Joomla we give priority to Readability over Performance, even when performance is a must.

To explain that let me show an example: Let's say that we want to fill a field Username in a login form.

<source lang="html4strict">
<form action="administrator/index.php" method="post" id="form-login">
<label for="username_field">Username</label>
<input name="username_field" tabindex="1" id="username_field" type="text" size="15" />
...
</source>

the most performant way to fill that form field would be:

<source lang="php">
$I->fillField('#username_field', 'Mark');
</source>

And usually we would move that to a page object element ending in:
<source lang="php">
$I->fillField(\LoginPage::$username, 'Mark');
</source>

However Codeception is a smart framework and it adds some magic to it's methods (see: https://github.com/Codeception/Codeception/blob/2.0/src/Codeception/Module/WebDriver.php#L511-L513). It allows me to write more readable tests (keeping performance hight).

If we do this:
<source lang="php">
$I->fillField('Username', 'Mark');
</source>

Codeception will be smart and will search first in the page if there is any "LABEL" called Username. That is a fast operation, so performance will be affected just a little. And instead we have written less code than in previous examples.

Note: sometimes this tricks are not always possible, labels are not always there or there are some elements hidden that shows and hides depending on a Javascript. All these special cases would require a Page element.

Still there is a definitive method of using locators that made them readable and performant called: strict Locators see [[Testing_Joomla_Extensions_with_Codeception#Writting_reliable_locators]].

With them we do:

<source lang="php">
$I->fillField(['id' => 'username_field'], 'Mark');
</source>

In conclusion we have more readable tests and less code to maintain while keeping performance. That is a win!

== Setting Up Codeception ==
=== setting up the repository ===
'''clone the directory'''

# Fork [https://github.com/joomla-projects/com_localise com_localise]
#
# Git clone git@github.com:*your-github-profile-name*/com_localise.git

=== Testing with Codeception ===

There are two ways to get and run codeception, via PHAR or via Composer. Using '''Composer is recommended''' (because we are using in some tests the Codeception 2.1 development version not available in the composer.phar).

*'''Using Composer'''

You need to have Composer in your system, if not download it from here: https://getcomposer.org/

Step 1: composer update

Step 2: run Codeception by doing: php vendor/bin/codecept build

*'''Codeception.phar'''

Linux Machine : wget http://codeception.com/codecept.phar

Windows Machine: Download from [http://codeception.com/install codecept.phar]

Step1 : php ./codecept.phar build

=== Running the Test ===
Run Selenium server
<source lang="bash">
# Download
curl -O http://selenium-release.storage.googleapis.com/2.45/selenium-server-standalone-2.45.0.jar

# And start the Selenium Server
java -Xms40m -Xmx256m -jar /Applications/XAMPP/xamppfiles/htdocs/selenium/selenium-server-standalone-2.45.0.jar
</source>
Rename tests/acceptance.suite.dist.yml to tests/acceptance.suite.yml
<source lang="bash">
Step 1: Modify the configuration at tests/acceptance.suite.yml to fit your server details.
</source>

<source lang="bash">
Step 2: php codecept.phar run
</source>
with --steps to see a step-by-step report on the performed actions.

<source lang="bash">
php vendor/bin/codecept run --steps
</source>

with --html. This command will run all tests for all suites, displaying the steps, and building HTML and XML reports. Reports will be store in tests/_output/ directory.

<source lang="bash">
php vendor/bin/codecept run --html
</source>

To activate the debug mode in Codeception just add the parameter --debug when you run the tests:

<source lang="bash">
php vendor/bin/codecept run acceptance --debug
</source>

== Best Practices at Testing ==
=== Writting reliable locators ===
Writing good locators can be tricky. The Mozilla team has written an excellent guide titled [https://blog.mozilla.org/webqa/2013/09/26/writing-reliable-locators-for-selenium-and-webdriver-tests/ Writing reliable locators for Selenium and WebDriver tests].

If the locator is an array, it should have a single element, with the key signifying the locator type (`id`, `name`, `css`, `xpath`, `link`, or `class`) and the value being the locator itself. This is called a "strict" locator. Examples:

<pre>
* ['id' => 'foo'] matches `<div id="foo">`
* ['name' => 'foo'] matches `<div name="foo">`
* ['css' => 'input[type=input][value=foo]'] matches `<input type="input" value="foo">`
* ['xpath' => "//input[@type='submit'][contains(@value, 'foo')]"] matches `<input type="submit" value="foobar">`
* ['link' => 'Click here'] matches `<a href="google.com">Click here</a>`
* ['class' => 'foo'] matches `<div class="foo">`
</pre>

=== How to use URLs ===
Codeception documentation suggests to use URL's as properties of a Page Object:

<source lang="php">
$I->amOnPage(JoomlaInstallationConfigurationPage::$URL);
</source>

Instead of hardcoding the url in the test:
<source lang="php">
$I->amOnPage('/administrator/index.php?option=com_banners&view...');
</source>

The pros of this approach is:
- first way is more readable for non developers.
- it helps to make tests more maintenable in the case of a url change in the system

However in joomla a change in an url is rare, and if it happens changing it will just be a Find&Replace task. I Joomla test we want to have the benefit of both, the url and a representative name that describes the page where we are going. That will make our tests more readable. Thus, we will write the urls the following way:

<source lang="php">
$I->amGoingTo('go to Create New Banner page at Joomla Administrator');
$I->amOnPage('/administrator/index.php?option=com_banners&view...');
</source>

=== Working with Hidden Elements ===
Selenium can't interact with elements that are not visible:

<source lang="html4strict">
<a href="http://www.joomla.org" style="display: none;" id="joomla_site">go to joomla</a>
</source>

In this case you can't do:
<source lang="php">
$I->click('go to joomla');
</source>

Usually this happens when you need to wait for a Javascript animation that end up showing that element, so in this case you will need to do this:
<source lang="php">
$I->waitForElementVisible('#joomla_site');
$I->click('go to joomla');
</source>

=== When do not use contains ===
We do not recommend to use the function contains on XPath because is not specific and can create false positives at tests.
See: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS/pull/99#issuecomment-69004191
=== Always add Strict Locators to your tests ===
Performance in tests is very important. You can reduce dramatically the time spent on a test with just adding a few extra locators. For example, the following code pertains to a test:

<source lang="php">
// see($text, $selector = null)
$I->see('Your article has been published');
</source>

In the previous code we are not facilitating the "Selector" so Codeception will have to search for the element in all the HTML. Doing this instead:

<source lang="php">
$I->see('Your article has been published', ['id' => 'messages']);
</source>

the tests went from: Time: 1.17 minutes
to: Time: 49.18 seconds

You can see this video of a real example: http://www.youtube.com/watch?v=0JCv0BR2yZY

Losing 30 seconds in every Assertion can delay your tests dramatically. Therefore, remind always to add xPath locators to all your Assertions.

Allowed locator mechanisms are:

<source lang="php">
- ['id' => 'xxx']
- ['name' => 'xxx']
- ['css' => 'xxx']
- ['xpath' => 'xxx']
- ['link' => 'xxx']
- ['class' => 'xxx']
</source>

[[Category:Automated Testing]]

==== Using locators in $I->see ====
Do not use ''see'' without locator:
<source lang="php">
// Wrong:
$I->see('Your article has been published');

// Right:
$I->see('Your article has been published', ['id' => 'messages']);
</source>

==== Using locators in $I->waitForText ====
Do not use ''waitForText'' without locator:
<source lang="php">
// Wrong:
$I->waitForText('Finalisation');

// Right:
$I->waitForText('Finalisation', 10, ['css' => 'h3']);
</source>

Incase of an element has multiple css classes, When Using CSS Locators make sure you use more specific class as locator:
<source lang="php">
// Wrong:
$I->waitForText('Item Succesfully Created', 10, ['class' => 'alert']);

// Right:
$I->waitForText('Item Succesfully Created', 10, ['class' => 'alert-success']);
</source>
A page could have mutiple elements which can have ''alert'' css class associated, hence being more specific helps.

==== How much time should I wait for an Element or Text? ====
You may have noticed that the second parameter in the I waitForText is an integer that represents how much "time to wait" in seconds:

<source lang="php">
$I->waitForText('a text to wait for','60',['...' => '...']);
</source>

But, how much time is the right time to wait for a text?

PHP maximum execution time before returning a Fatal Error for timeout is set by default to 30 seconds. '''We suggest to set it for 60 seconds''', because running the tests in slow computers can easily get to that time in some tasks.

If a waitForText command takes over 10 seconds, it will much probably mean that something is not performing well. Maybe a non [[Testing Joomla Extensions with Codeception#Always_add_Strict_Locators_to_your_tests|Strict Locator]] is being used and Selenium takes to much time to find the element. However we have even identified cases were some steps take longer than 30 seconds in very slow computers, specifically installing joomla, see https://github.com/joomla-projects/joomla-browser/commit/b70f195140e599649cf98f051d7a31388c4f1632. For this cases we can't do much, other than recommend to add more memory to the local web server.

=== Quote and Double Quotes in Complex XPaths ===
Sometimes you will have to write XPaths that looks like:

//button[@onclick='Joomla.submitbutton("config.save.application.apply")']

When moved to a Page Object you will probably will face this situation:

[[File:System_tests_error_escaping_quotes_on_xpaths.png|framed|center|Typical issue when you write a long XPath in a Page object]]

To avoid it remind to escape the quotes:

<source lang="php">
// Wrong
public static $elements = array(
'Save' => "//button[@onclick="Joomla.submitbutton('config.save.application.apply')"]"
);
// Right
public static $elements = array(
'Save' => "//button[@onclick=\"Joomla.submitbutton('config.save.application.apply')\"]"
);
</source>

===Generating txt/html scenarios===
Codeception allows you to generate user-friendly text scenarios from scenario-driven from Cest and Cept php test (see http://codeception.com/docs/reference/Commands#GenerateScenarios).

===Don't use double quotes, use single quotes instead===
Do not use double quotes (") for surrounding strings:
<source lang="php">
$I->waitForText("Congratulations! Joomla! is now installed.", 30);
</source>

If you do, when you [[Testing_Joomla_Extensions_with_Codeception#Generating_txt.2Fhtml_scenarios|generate the scenarios]] you will get this bad result:

I wait for text ""Congratulations! Joomla! is now installed.""," 30"

If you use single quotes instead:

<source lang="php">
$I->waitForText('Congratulations! Joomla! is now installed.', 30);
</source>

You will get the right expected result:

I wait for text 'Congratulations! Joomla! is now installed.'," 30"

The reason of not being able to use double quotes is due to a bug in Codeception humanize funtions, see issue: https://github.com/Codeception/Codeception/issues/1847

===Do not leave spaces between parameters in Cepts===
See the two lines:
<source lang="php">
// Wrong
$I->waitForText('Main Configuration', 10, 'h3');
// Good
$I->waitForText('Main Configuration',10,'h3');
</source>

If you do, when you [[Testing_Joomla_Extensions_with_Codeception#Generating_txt.2Fhtml_scenarios|generate the scenarios]] you will get this bad result:

I wait for text 'Main Configuration'," 10"," 'h3'

The reason that you are asked to not add spaces between parameters is due to a bug in Codeception humanize funtions, see issue: https://github.com/Codeception/Codeception/issues/1847

===Write complex locator VS. modifying the output of the tested website===
Sometimes we need to write a very complex xpath to locate a element in the page, for example:

$I->click(['xpath' => "//*[@id=\"menuList\"]/tbody/tr/td[2]/a[contains(text(), 'weblink')"])

wouldn't be much better to write something like this instead?

$I->click(['class' => "lc-menu_item_type_weblinks"])

When you find yourself writting a very complex locator in a test, is maybe because the markup of the Website is wrong. For this cases, is better to stop writing the test and reconsider the possibility of modifying the website that we are testing. There is nothing that prevents us to improve Joomla markup. Actually is the other way arround, with these fixes we are probably making Joomla more accessible.
We have had experiences in the past, see for example this issue: https://github.com/joomla/joomla-cms/issues/7207.

In conclusion is much more convenient to add just a simple class to the element to easily locate it instead of becoming mad finding the right xPath. Remind that is important that our tests are readable, and that has to do with using readable locators.

In order to simplify locators used in Acceptance tests we add special locator classes into HTML of web pages. So not to confuse them with classes needed by CSS or JavaScript we use '''lc-''' prefix. Thus, if you find locator to be to complex, it would be much easier to edit HTML and add a new class into it.

$I->click('class' => "lc-comment-delete');

Where ''lc'' stands for ''locator''.

Is important that the rest of Joomla coders know that this '''lc-''' prefix is used by the tests to prevent anyone from removing it.

This recommendation was originally suggested by Davert (the creator of Codeception) at http://phptest.club/t/codeception-tips-tricks/14/8.

===Thoughts on Selenium IDE and the codeception Formatter===
One can use the [http://www.seleniumhq.org/projects/ide/ Selenium IDE] with the [https://addons.mozilla.org/en-US/firefox/addon/codeception-formatters/ codeception Formatter].
Using the Selenium IDE to write the tests seems way easier than writing them in PHP (since you have immediate feedback on what's going on the page), but it also poses some issues.
For the most part the Joomla-Browser has functions that we can use to do standard stuff like login, logout etc. If we do our tests with the Selenium IDE we cannot use those and our tests get filled up with stuff that we have already abstracted.

There is still use of the Selenium IDE though, we could use it to create the tests for specific functionality. Like just writing an article, setting publish_up and publish_down dates and then saving. When we export the result with the codeception formatter we would have the necessary PHP and we can add the rest of the stuff for the test to be fully automated (login, navigate to page etc, then execute the exported test). This could speed the creation of tests and we could use non-developers for this kind of work. However this is easier said than done. Due to the Javascript that we use in Joomla simple tests are not that simple. For example clicking in the texteditor and writing text in it is not registered by the IDE since the editor is created by TinyMCE... A way to add text to the editor is to use

Command | runScript
Target | tinyMCE.get('text_area_id_not_iframe_id').setContent('Your text')

That is again a technical solution to a test that should have been easy in the first place.
We get into the same trouble with selecting a date out of a Calendar field. So at the end it seems pretty difficult for non-developers to create tests that we could use, because most of the steps recorded by the Selenium IDE won't work a second time.

If we find a way to make the work with Javascript elements on the page easier, then Selenium IDE could be a great tool that could help us write far more tests, than we currently have in a less time.

As far the codeception Formatter is concerned - it hasn't been updated in 2 years, but if we find out how to use the Selenium IDE extending the formatter and building on top of it shouldn't be a show stopper.

<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

Pizza Bugs and Fun October 17, 2014

2014-10-17T15:14:37Z

THE AI: Explained what the user needs to do after he tests an issue.

[[Image:pbf.png|225px|left]]

A Joomla! Pizza, Bugs and Fun event is scheduled for Friday, October 17, 2014. The event is global for virtual participants (both businesses and individuals), with local venues wherever they are organized. The key goal is to fix as many Joomla 3 and Joomla 2.5 bugs as possible.

'''See the section [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#General_Instructions General Instructions] below for instructions.'''

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

Follow [https://twitter.com/joomlabugsquad @JoomlaBugSquad] on Twitter for updates during PBF and some social fun. The ''Twitter''' hash tag is #JoomlaPBF.
<div style="clear:left;" />
== Goals ==
* '''Bugs''' : We will be working through the [http://issues.joomla.org/ CMS Issue Tracker] where there are bug reports needing patches and/or testing.
* '''Documentation''' : If you want to help out writing documentation, you're also more than welcome. See the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#If_you_want_to_work_on_Documentation Documentation Details] below for suggestions.

== Organization, logistics and communications ==

=== Communication ===
See the [[Pizza_Bugs_and_Fun_October_17,_2014#Chat|Chat section]].

=== Training Sessions ===
There was an optional webinar training session on 16 October, 2014 at 15:15 UTC. Please use the chat and documentation below for additional resources.

Also, on 16 & 17 October, 2014, [[Pizza_Bugs_and_Fun_October_17,_2014#Chat|the chat]] will be open for a Q&A and for help getting started.

=== Recognition ===
We've dubbed the event as a Business PBF, since it's the second PBF on a weekday (Friday) and we'd like to get more business involved. We've created badges that you can use on your sites to spread awareness of the event and get recognition for your participation: http://developer.joomla.org/pbf

Furthermore, we'd like to give you more recognition and highlight your pledge of participation by placing your logo and a link to your site on the landing page: http://developer.joomla.org/pbf

There are four participations levels: Epic, Platinum, Gold, and Silver. Platinum is for 10 hours or more pledged to the event. Gold is four hours or more pledged. Silver is pledged to participate in the event. And Epic for 100+ hours pledged!

So, for example, if Company ABC had five of their developers for two hours, then they could use the Platinum badge and have their logo (and link) in the platinum area on the landing page.

The hours you choose to pledge towards the event is totally up to you as an individual or business. As a bonus, if you write a blog post about the event, you can count it as 30 minutes towards your pledge. So if you pledged 5 hours and write a blog post, you'd be helping at the event for 4.5 hours.

Finally, on the day of the event, come and go as you'd like and fulfill your pledged hours. You can help with testing bug fixes, reporting bugs, coding bug fixes, etc. Most of all, enjoy every minute! Have fun, enjoy the fellowship, learn, and make Joomla better for you, your business, your clients, and your friends.

=== General Instructions ===

These instructions may change as we get closer to the event.

==== Task List ====
We have a list of [http://issues.joomla.org/?label=38 suggested items] available to work on. They range from very easy to intermediate difficulty. However, you're not just limited to this list and using the below process you can test/code for any items:

==== If you want to test bug fixes (i.e. patches) ====
* Look for issues with a status of Pending. We want at least 2 testers and more on complex issues, so you can test what others have tested already.
* Use the [http://issues.joomla.org/ CMS Issue Tracker] as usual, which means you can use the [[Component Patchtester for Testers|Joomla Patch Tester]].
* Most of the issues should have test instructions with them.
* [[File:Submit_test_result.png|thumb|Submit test result]] Once you have tested then please submit a result using the Submit test result button. What is good to do as well is to leave a comment with more details. For example the comment could look like this: <tt>I have looked at this issue. I was able to confirm the issue AND after applying the patch I can confirm the issue is resolved</tt>

* Note: You don't have to delete the installation folder when you are using the development version of Joomla. This allows you to reinstall just by deleting the configuration.php file.
* Note: See the [http://docs.joomla.org/Pizza_Bugs_and_Fun_October_17,_2014#FAQ FAQ] on how to apply a Git pull request.

:<h5>Helpful Documentation</h5>
:* [[Component Patchtester for Testers]] - We'd recommend beginners to use the [[Component Patchtester for Testers|Joomla Patch Tester]]

==== If you want to code bug fixes ====
* Use the [http://issues.joomla.org/ CMS Issue Tracker] as usual, looking for the issues with a status of Confirmed.
* Send in a [[Git for Coders|pull request (PR)]]. Add testing instructions if they don't already exist.{{-}}<h5>Helpful documentation</h5>
:* [[Component Patchtester for Testers]]
:* [[Git for Testers and Trackers]]
:* [[Using the Github UI to Make Pull Requests]] - this is the easiest way to submit simple pull requests
:* [[Git for Coders]]
:* [[Working with git and github/My first pull request]]
:* [[Secure coding guidelines]]
:* [[Development Best Practices]]
:* [http://www.slideshare.net/patelgunjan/joomla-pizza-bugs-and-fun-2014-preevent-seminar Joomla! Pizza Bugs and Fun 2014 pre-event Seminar]

==== If you want to work on Documentation ====
[[File:Documentation all together tranparent bkgd.png|150px|right]]
* To edit this Documentation Wiki, you will need a user account on the wiki. If you don't already have one, you may register on [[Special:UserLogin]]. You only need a valid email address to register. After confirming your email address you will have immediate permission to edit any page except for a few that are protected because they are high profile spam targets.
* '''Important!''' - You should review the [[JDOC:Wiki policy|Wiki policy]] and our use of [[User:Abuse filter|Abuse filters]] for new users.
* Get your user account a few days before and make sure that you are able to sign in since the automatic authorization system can lock some people out.
* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
* During the PBF, several experienced Wiki editors will be available in the chat to help you.

{{:{{PAGENAME}}/Documentation needs}}

=== Pizza ===
We are offering pizza (or any comparable locally popular main course) and soda for pre-registered groups. We are not setting a specific maximum, but please don’t go crazy with it. Get enough so there’s plenty for everyone, but not a week’s worth of pizza and soda leftovers for everyone. Contact Nick Savov (nick.savov[at]community.joomla[dot]org , replace [at] with @ and [dot] with .) before the event to register and get details.

== Locations ==

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

If you set up a location please send contact information to Nick Savov (nick.savov[at]community.joomla[dot]org , replace [at] with @ and [dot] with .). Feel free to contact him with any questions.

===Virtual===

The event is global and across all timezones on October 17th, 2014 (48 hours total). You can come and go as you'd like and fulfill your pledged hours. You can help with testing bug fixes, reporting bugs, coding bug fixes, etc. Most of all, enjoy every minute! Have fun, enjoy the community, learn, and make Joomla better for you, your business, your clients, and your friends.

There are also some physical venues... see below.

====Twitter====
Follow [https://twitter.com/joomlabugsquad @JoomlaBugSquad] on Twitter for updates during PBF and some social fun. The ''Twitter''' hash tag is #JoomlaPBF.

====Chat====
We have a dedicated chat for the PBF event at https://joomla.slack.com/messages/pbf/

All registrants manually get emailed an invite link soon after they complete the [https://docs.google.com/a/community.joomla.org/forms/d/1yQRmN9U3ob0iIsGWiemuwqU3Sp5twCS95P6vvI7BN8M/viewform pledge form]. If you have a team, please email nick.savov[.at.]community.joomla.org with a list of your team members emails, so that invites can be sent to them.

=== Europe ===

==== Netherlands ====
[http://www.joomlacommunity.eu/nieuws/joomla-in-nederland/976-joomla-pizza-bugs-en-fun-nederland.html Joomla Pizza, Bugs & Fun in Enschede, The Netherlands]
Date: Friday, October 17, from 10:30 - 18:00
Location: de Bibliotheek, Pijpenstraat 15, 7511 GM Enschede
To attend, please add yourself to: http://www.joomlacommunity.eu/joomla-gebruikersgroepen/details/483.html

==== France ====
[http://joomla.fr/actualites-de-joomlaorg/joomla-pizza-bugs-and-fun-professionnel-automne-2014 Joomla Pizza, Bugs & Fun à Lyon, France]
Date: Friday, October 17
Time: We're open all day long so people can come and go
Location: Acyba - Hikari Software, 110 Avenue Barthélémy Buyer, 69009 Lyon
To attend or for more information, please email nicolas[.at.]hikashop.com

[http://joomla.fr/actualites-de-joomlaorg/joomla-pizza-bugs-and-fun-professionnel-automne-2014 Joomla Pizza, Bugs & Fun à Toulouse, France]
Date: Friday, October 17
Time: We're open all day long so people can come and go
Location: Agence Com'3elles, Immeuble Anadyr, 108 route d'Espagne, 31100 Toulouse
To attend or for more information, please email celine.robert[.at.]@com3elles.com

==== Denmark ====
Joomla Pizza, Bugs & Fun in Denmark
Date: Friday, October 17
Time: 10:00am-6:00pm
Location: redWEB HQ, Blangstedgårdsvej 1, 5220 Odense SØ
To attend, please write to: pbf[.at.]redweb.dk

==== Bulgaria ====
Joomla Pizza, Bugs & Fun in Bulgaria
Date: Friday, October 17
Time: 9:00-15:00
Location: SiteGround at Racho Petkov Kazandjiata 8, Sofia
To attend, please email: events[.at.]siteground.com

=== North America ===

=== South America ===

=== Asia/Pacific ===

==== India ====
[http://tasolglobal.com/ '''Tailored Solutions Pvt. Ltd.''']
Date: Friday, October 17, from 9:00 am to 6:30 pm.
Location: 406, Arth Complex,
Anand nagar Road,
Satellite,
Ahmedabad - 380015,
Gujarat, India.

[http://www.meetup.com/Joomla-User-Group-Pune/events/211495652/ Joomla Pizza, Bugs & Fun in Pune, India]
Date: Saturday, October 18, from 15:00 to 22:00
Location: Techjoomla/ Tekdi Technologies Offices, Office No.6, Silver Fern Building. Karve Road. Opposite Kothrud Bus Stand & Above Canara Bank., Pune

==== Thailand ====
CMSPlugin.com's Team and Marvelic Engine' Team
Date: Friday, October 17, from 10:00 to 20:00
Localtion : Marvelic Engine Co.,Ltd., 719 KPN Tower, 10/F, Rama 9 Road. Huaykwang, Bangkok 10310.
[http://www.marvelic.co.th/th/contact-us.html http://www.marvelic.co.th/th/contact-us.html]

=== Africa ===

=== Middle East ===

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

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

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

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

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

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

A: The current Joomla code can be found on GitHub.

*GitHub - https://github.com/joomla/joomla-cms

Q: Which one is 3.3?

A: On GitHub, it is the staging branch: [https://github.com/joomla/joomla-cms https://github.com/joomla/joomla-cms]

Q: Which one is 2.5?

A: On GitHub, it is the 2.5.x branch: [https://github.com/joomla/joomla-cms/tree/2.5.x https://github.com/joomla/joomla-cms/tree/2.5.x]

Q: How do I apply a Git pull request?

A: Use the [[Component Patchtester for Testers|Joomla Patch Tester]]

==Contributors==
{{:Pizza Bugs and Fun October 17, 2014/Contributors List}}

<noinclude>[[Category:Bug Squad]]
[[Category:Development]][[Category:Events]]</noinclude>

File:Submit test result.png

2014-10-17T15:10:58Z

THE AI: Shows what the user has to submit once he checks an issue.

== Summary ==
Shows what the user has to submit once he checks an issue.
== Licensing ==
{{JEDL}}

GSOC 2014 Project Ideas

2014-02-23T19:53:46Z

THE AI: /* Project: Component for managing predefined emails */

[[Image:GSOC_2014.png|300px|left]]

Welcome to the Joomla! Google Summer of Code (GSoC) 2014 project ideas page. As we move forward with the 2014 version of the Joomla! GSoC, we will use this page to develop possible project ideas. Please note that anyone who is interested can participate in this process. You do not have to be a GSoC student or mentor to suggest possible project ideas. Please keep in mind that projects need to be realistically something that is able to be functionally completed by a student working full time for about eight weeks. Thanks!

For students who want a general overview of Joomla's GSoc, project plans, proposals, and timelines, please [http://docs.joomla.org/GSOC_2014 refer to the GSoC 2014 page].

Discussion of ideas and other GSoC related items is welcome on our Google Group: https://groups.google.com/d/forum/joomla-gsoc-2014

If you are interested in participating as a student please review the materials on applying that are available at [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2013/help_page Google]. We strongly encourage you to ask questions about process and ideas on the mailing list.

If you are interested in serving as a mentor, please fill out the [https://docs.google.com/a/community.joomla.org/spreadsheet/viewform?formkey=dHA2V1lJbThYQXpwMERiRG1FOTZlV3c6MA Mentor Application Form 2014].

== Ideas ==

Opportunities exist for students to work with projects from either the Joomla CMS, the Joomla Framework or in some cases a combination of both.

In addition to this ideas list, the Joomla! Community is able to voice their opinion on features they would like to see via the [http://ideas.joomla.org/ Joomla! Idea Pool]. Those wishing to add ideas to this listing are encouraged to review the Idea Pool and base their idea on the input received there. You can also view the past lists for [[GSOC_2012_Project_Ideas|2013]], [[GSOC_2012_Project_Ideas|2012]], [[Summer_of_Code_2010_Project_Ideas|2010]] and [[Summer_of_Code_2009_Project_Ideas|2009]], which may be useful for reference. We ask that you keep ideas realistic for the time frame that students will have to complete their projects.

Unless a mentor has proposed a specific project, mentors from the mentor pool will be matched with student projects. However members of the mentor pool are available to answer questions on the Joomla GSoC mailing list.

== Important Guidelines on Submitting Ideas ==

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 19th 2014 and August 18th 2014. This is a very 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.
* Keep ideas core. The purpose of GSoC is to improve Joomla itself. This is not the time to add ideas for new extensions or features that may not be included by the PLT. 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.
* Respect Joomla's Release Cycle. Joomla's release cycle currently states that with Joomla 3.5, we will not add new features to the CMS. This means that most of the GSoC projects this year should ideally improve existing code in a backwards compatible way.
* Joomla 4. Currently there is not a baseline for what Joomla 4 is and what it could be. Ideas centered around Joomla 4 would not fit in well with the goal of GSoC 2014.
* When in doubt, reach out. If you're unsure if your idea belongs on this list, please post to the GSoC 2014 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.

== Joomla CMS Ideas ==

* [http://github.com/joomla/joomla-cms Source Code]
* [http://groups.google.com/d/forum/joomla-dev-cms Developer Mailing List]

{{tip|Please add your CMS project ideas below. You can use the '''[[GSOC 2014 Project Ideas/template|GSOC 2014 Project template]]'''.|title=Adding Project Ideas}}

===Project: Refactor CMS to use Dependency Injection ===

:'''Brief explanation:''' The CMS currently has many hard-coded JPATH constants and a JFactory for developers to get certain global objects from the application. This project would develop a way to depreciate the current system which is difficult to test and is tightly coupled. The project will replace the JPATH constants with the Joomla Framework Dependency Injection package, allowing for a looser coupling of the application's core components.

For more info see:
* [https://github.com/joomla/joomla-framework/tree/staging/src/Joomla/DI Joomla Framework DI Package]
* [https://github.com/joomla/joomla-cms/blob/staging/includes/defines.php Joomla CMS Constants]

:'''Expected Results:'''
* Deprecate the current JPATH constants allowing for replacement with Joomla DI
* Refactor core components and to use new DI container
* Write documentation for developers to update their extensions to use Joomla DI

:'''Knowledge Prerequisite:''' PHP, object-oriented programming, Joomla CMS (from a user point of view), Understanding of Dependency Injection and Dependency Injection Containers.

:'''Difficulty:''' Medium to Hard

===Project: Webdriver system tests for CMS===

:'''Brief explanation:''' Automated system tests allow us to test the CMS by automatically running Joomla from a browser, selecting menu options, and evaluating results. At present, several number of [https://github.com/joomla/joomla-cms/tree/staging/tests/system system tests] are currently completed using the Selenium Webdriver technology and using the Page Objects pattern to separate the page objects from the test objects. This project will build on the current base of Webdriver tests and expand the test coverage to include more of the CMS.

For more info see:
* http://docs.joomla.org/System_Testing
* http://www.youtube.com/watch?v=8Mmg32lg4nA

:'''Expected Results:'''
* finish the administrator parts not yet tested
* add front end testing:
** menu items
** modules

:'''Knowledge Prerequisite:''' PHP, object-oriented programming, Joomla CMS (from a user point of view), HTML

:'''Difficulty:''' Medium to Hard

:'''Possible mentors:''' Puneet Kala, Mark Dexter and Javier Gómez

=== Project: Collection of Mini Projects ===

:'''Brief explanation:''' The CMS currently could due with several smaller tasks and projects to help move the software forward and improve its usability and feature set. This project is a *collection* of several smaller projects and improvements. The tasks involved are discrete but they must all be accomplished to a high degree of quality in detail to be considered successful.

===== Decouple Core Extensions =====
:''' Description''' In the current version of the CMS, some extensions rely on one another for functionality. The ultimate goal is for each extension to be completely independent so that it could be removed without breaking the functionality of another.

===== Add Menu Type ACL =====
:''' Description ''' Currently in the CMS there is no way to have backend based ACL rules per menu-type. This project should add advanced ACL rules and configurability to Joomla's core menu types. Adding, deleting, and editing menus on a per-menu group basis should be available on a per-group basis.

===== JError to Exceptions =====
:''' Description ''' Currently Joomla uses the JError class to handle error management - however there is a desire to move this across to use exceptions for Joomla 4.0 and remove the JError class.

:'''Expected Results:''' This project must address and complete each of the above described mini-projects. Proposals should detail each item in detail and outline a timeline for completing them.

===== Implementing Frontend Menu Editing =====
:''' Description ''' Currently frontend menu editing icon redirects user to backend. But actually frontend menu editing should be able to done at the frontend.Implementation would be much similar to the already implemented frontend configuration & frontend template style editing.

:'''Expected Results:''' Frontend logged authorized users should be able to edit menu items via frontend. Student should have to figure-out what should be in frontend editor and relevant access control levels.

:'''Knowledge Prerequisite:''' General knowledge of Joomla 3's core feature set and functionality.

:'''Difficulty:''' Medium to Hard

=== Project: Develop dependency manager ===

:'''Brief explanation:''' Distributions are one of the next possible evolutionary steps for the CMS. One key challenge to solve is the management of dependencies that extensions/packages may have.

:'''Expected Results:''' A working proof of concept that manages the handling of dependencies as well as define requirements that extensions/packages must meet for their dependencies to be managed by this system.

:'''Knowledge Prerequisite:'''

:'''Difficulty:''' Very challenging, but highly rewarding.

=== Project: Update Core Extensions to use New MVC ===

:'''Brief explanation:''' The Joomla Framework has brought us a new MVC architecture that we would like to start using for core components. This project will chose a few core components as a conversion goal to migrate them to run on the new MVC structure.

:'''Expected Results:''' Selected core components will run on the new MVC architecture. This will involve changing the component to run the new controller based architecture, and potentially develop a standardized set of methods that are used across multiple extensions. Reducing code repeats and encouraging reuse will be an important aspect of this project.

:'''Knowledge Prerequisite:'''

:'''Difficulty:''' Challenging, high learning curve and will set precedent for other extensions. This is a opportunity for innovation, not a project to simply copy other parts code into a new feature.

:'''Potential Mentors:''' Soren Beck Jensen as he runs the http://www.Component-Creator.com and Buddhima Wijeweera as he worked on a similar project for GSoC 2013 http://magazine.joomla.org/issues/issue-nov-2013/item/1580-new-mvc-for-joomla-cms

===Project: SQL Optimization===

:'''Brief explanation:''' The goal of this project is to optimize site performances, between the potential areas where performance bottleneck resides in a conventional n-tier website architecture, we'll focus our effort on database side, optimizing slow sql queries.

:'''Expected Results:''' After analyzing and measuring the site performance (on some test case ie small, medium, big) will be taken the necessary action using the proper techniques to improve measurably the slower queries.

:'''Knowledge Prerequisite:''' SQL, DBMS

:'''Difficulty:''' Medium to Hard

:'''Potential mentors:''' Nicola Galgano

===Project: JIssues tracker===

:'''Brief explanation:''' The goal of this project is to finish the JIssues tracker so it is in a position to replace the current Joomla tracker.

:'''Expected Results:''' The JIssues tracker will be at a place where a transition can take place from Joomla Code to the issues tracker. This will involve working with the JIssues (http://issues.joomla.org/) and working through the issue list (https://github.com/joomla/jissues) as well as contributing any relevant code back into the Framework Project

:'''Knowledge Prerequisite:''' Joomla Framework, JoomlaCode, Joomla Bug Tracking Process

:'''Difficulty:''' Medium to Hard

:'''Posible mentors:''' Michael Babker




<noinclude>[[Category:Google Summer of Code 2014]]</noinclude>

===Project: Component for managing predefined emails ===

:'''Brief explanation:''' Many Joomla! extensions send confirmation mails to users. It will be great if Joomla! provides a powerful component, which will be used for creating predefined emails. The component has to provide classes, which will be used from developers for loading, parsing and sending those e-mails.

:'''Expected Results:'''
* Administration interface that will provide an easy way for creating and managing predefined emails.
* Classes that will be used for loading, parsing and sending those emails.

:'''Knowledge Prerequisite:''' PHP, object-oriented programming, Joomla CMS.

:'''Difficulty:''' Medium to Hard

:'''Possible mentors:''' Todor Iliev, Daniel Dimitrov

== Joomla Framework ==

The Joomla Framework project ideas allows for ideas that can work within the Joomla CMS, or could be completely separate applications that have no connection at all. The Joomla Framework allows for applications to be built for the command line, process daemons and the web.

References:
*[http://github.com/joomla/joomla-framework github Source Code]
*[http://developer.joomla.org/framework/roadmap.html Development Roadmap]
*[http://groups.google.com/d/forum/joomla-dev-framework Developer Mailing List]

All code contributions must follow Joomla coding standards and include full unit test coverage.

{{tip|Please add your Framework project ideas below. You can use the '''[[GSOC 2014 Project Ideas/template|GSOC 2014 Project template]]'''.|title=Adding Project Ideas}}

===Project: Framework Unit Testing===

:'''Brief explanation:''' The Joomla Framework has a good suite of automated Unit Tests, but code coverage is lacking in some areas. The goal of this project is to improve the code coverage by writing unit tests for the Joomla Framework.

:'''Expected Results:''' The student will be expected to review the current [http://developer.joomla.org/framework-coverage/ code coverage report] for the Joomla Framework and write and agreed-upon number of unit tests with particular attention to packages that are below 50% coverage. Preference should be given to non-deprecated classes but the student may choose from either the core tree (/libraries/joomla) or the legacy tree (/libraries/legacy).

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

===Project: Improve Filesystem classes===

:'''Brief explanation:''' Replace static methods with public ones of classes File, Folder, Path. Let these things to be used as object with theirs methods and properties. Develop classes, which will be used as adapters, for some fundamental actions performed on those file system elements. The adapters should be for uploading, deleting, reading,...

:'''Expected Results:'''
* A set of well coded, fully unit tested and documented implementations for the file system classes.
* Adapters for managing files on some of the most popular cloud services - Amazon S3, Google App Engine,...
* Classes for validating files size, images,...

:'''Knowledge Prerequisite:''' GitHub, PHPUnit, PHP, OOP, Design Patterns, familiarity with web services and Joomla! Framework.

:'''Difficulty:''' Medium to Hard

===Project: Improve Date classes===

:'''Brief explanation:''' Develop classes and methods that will give more power to developers working with dates.

:'''Expected Results:'''
* Methods that calculate dates for yesterday, begin of week, end of week, begin of month, end of month, begin of year, end of year,...
* Methods that calculate time for begin of day, end of day,...

:'''Knowledge Prerequisite:''' GitHub, PHPUnit, PHP, OOP, Design Patterns, familiarity Joomla! Framework.

:'''Difficulty:''' Medium to Hard

[[Category:Google Summer of Code 2014]]

Archived talk:Developing a MVC Component/Adding ACL

2012-04-12T08:38:59Z

THE AI:

Somehow the ACL doesn't work on Edit permission for me. It shows both Save & New and Save as Copy buttons when it has no create rights. Gone through the code twice, but cannot see anything wrong with it... Anybody else have same problem? --[[User:A2Ggeir|A2Ggeir]] 10:19, 6 December 2010 (UTC)

Did a little debug and it seems the values from function canDo() in Helper does not return the right values when it is in edit view.

Result when in listview:
<code>
'core.admin' => NULL,
'core.manage' => true,
'core.create' => false,
'core.edit' => true,
'core.delete' => false,
</code>

Result when in editview:
<code>
'core.admin' => NULL,
'core.manage' => NULL,
'core.create' => true,
'core.edit' => true,
'core.delete' => true,
</code>

--[[User:A2Ggeir|A2Ggeir]] 12:02, 7 December 2010 (UTC)

== Delet dosn't work ==

when you want to delete a message it goes wrong and the message appears:

500 - Es ist ein Fehler aufgetreten

Layout „default“ nicht gefunden

downt know why its not working... maybee some can check this out.

Greetz

-------------------------------------------------------------------------------

Ok, so I have carefully followed the tutorial to here. What I need to know now is HOW do I allow a user who only has edit.own rights to get to the admin edit for the component??

I tried for a while to create an edit page on the front end, but no luck and no help. It occurred to me that perhaps if I could not bring the mountain to Mohammed, I could get Mohammed access to the mountain. But how to do it without making every user an administrator? Even a manager has too much other access.
<p>

[[User:IslandBilly|"In theory, there's no difference between theory and practice; in practice, there is" --Yogi Berra]] 10:14, 12 November 2011 (CST) Using v1.7

--------------------------------------------------------------------------------
I think that this example is missing something in the bind method.

// Bind the rules.
if (isset($array['rules']) && is_array($array['rules']))
{
$rules = new JAccessRules($array['rules']);
$this->setRules($rules);
}
If we don't bind the rules then they are not saved in the asset table for the message/item...

Archived:GSOC 2012 Project Ideas

2012-03-22T13:26:05Z

THE AI:

{{RightTOC}}

==Welcome!==
Welcome to the Joomla! Google Summer of Code (GSoC) 2012 project ideas page. As we move forward with the 2012 version of the Joomla! GSoC, we will use this page to develop possible project ideas. Please note that anyone who is interested can participate in this process. You do not have to be a GSoC student or mentor to suggest possible project ideas. Please keep in mind that projects need to be realistically something that is able to be functionally completed by a student working full time for about eight weeks. Thanks!

Discussion of ideas and other GSoC related items is welcome on our Google Group: https://groups.google.com/forum/?fromgroups#!forum/joomla-gsoc-2012

If you are interested in serving as a mentor, please fill out the [https://docs.google.com/spreadsheet/viewform?formkey=dERlY0dxekFUWEg4ME1YZDhVMDhJMGc6MQ#gid=0 Mentor Application Form].

If you are interested in applying as a student please see our [https://docs.google.com/document/d/1s5chDv-hekOXwgNAjjF-YMQKRaisigasPk-ZCW5KgNQ/edit application template]. You will need to register with Google and submit through their GSOC program.

If you are interested in participating as a student please review the materials on applying that are available at [http://code.google.com/soc/ Google]. We strongly encourage you to ask questions about process and ideas on the mailing list.

* [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2012/userguide#depth_mentor Guide for Mentors]
* [http://www.google-melange.com/document/show/gsoc_program/google/gsoc2012/faqs Google Summer of Code™ 2012 Frequently Asked Questions]

==Ideas==

Opportunities exist for students to work with projects from either the Joomla CMS, the Joomla Platform or in some cases a combination of both.

In addition to this ideas list, the Joomla! Community is able to voice their opinion on features they would like to see via the [http://ideas.joomla.org/ Joomla! Idea Pool]. Those wishing to add ideas to this listing are encouraged to review the Idea Pool and base their idea on the input received there. You can also view the past lists for [http://docs.joomla.org/Summer_of_Code_2010_Project_Ideas 2010] and [http://docs.joomla.org/Summer_of_Code_2009_Project_Ideas 2009], which may be useful for reference. We ask that you keep ideas realistic for the time frame that students will have to complete their projects.

Unless a mentor has proposed a specific project, mentors from the mentor pool will be matched with student projects. However members of the mentor pool are available to answer questions on the Joomla GSoC mailing list.

===Joomla CMS===

* [http://github.com/joomla/joomla-cms Source Code]
* [http://groups.google.com/d/forum/joomla-dev-cms Developer Mailing List]

====Project: Language Installation====

:'''Brief Explanation:''' Create an interface to install language packs from a generated list of accredited language packs during Joomla installation and subsequently from the administrator interface, either the extension manager or the language manager.

:'''References:'''
* http://joomlacode.org/gf/project/jtranslation1_6/frs/
* https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/updater

:'''Expected Results:''' The goal is to have code implementing this functionally complete and in a format ready for testings by the Joomla Bug Squad as a new feature in the CMS using the normal new feature process.

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, web services

:'''Difficulty:''' Medium to Hard

====Project: CMS Unit Testing====

:'''Brief explanation:''' The Joomla CMS has its own set of classes that augment the Joomla platform but these are not well tested. The goal of this project is to improve the code coverage by writing unit tests for library classes specific to the Joomla CMS.

:'''Expected Results:''' The student will be expected to review the current code coverage for the Joomla CMS libraries (/libraries/cms) and write and agreed-upon number of unit tests with particular attention to packages and classes that are below 50% coverage.

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

====Project: Query optimization ====

:'''Brief explanation:''' Profile the queries in the CMS and optimize them, insuring that they remain database agnostic.

:'''References:'''
* https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/database
* http://en.wikipedia.org/wiki/SQL

:'''Expected Results:''' Measurable improvement in the performance of the CMS. The project will likely also result in contributions to JDatabaseQuery and other related classes in the Joomla Platform.

:'''Knowledge Prerequisite:''' SQL, Joomla Platform (JDatabase), ANSI standards.

:'''Difficulty:''' Medium

====Project: Batch processing management/scheduler====

:'''Brief explanation:''' Brief explanation:Manage batch job’s processing, create, schedule and run jobs, such as backup,virus scan, billing, reports, emailing and much more

:'''Expected Results:''' The student will be expected to build an O.S. independent solution that act as a wrapper to manage jobs, allowing to manage tasks from third party extensions too, in a easy way simplifying the Joomla webmaster life
See: http://en.wikipedia.org/wiki/Batch_processing

:'''Knowledge Prerequisite:''': PHP, Joomla CMS, Joomla Platform, Mysql, Operating Systems.

:'''Mentor:''': Nicola Galgano

====Project: Add Article Image support to Core Content Modules====

:'''Brief explanation:''' Joomla 2.5.x ships with several core content modules. These modules can display article lists or links. However they do not support bringing in article images. This project would be to make some minor code updates to all the core content modules to add article image support and parameters. Some basic parameters would be to show / hide the article image, specify a thumbnail size, enable or disable article links on the image, and whether or not to respect the image's proportion when resized as a thumbnail.

:'''Expected Results:''' The student will be expected to modify and update Joomla's core content modules and make modifications to the multiple files in the MVC structure to add parameters, and add additional code to the module's HTML output. The module should interface with the Joomla core class JImage as well to create the thumbnail image.

:'''Knowledge Prerequisite:''' PHP, Joomla! Framework

:'''Difficulty:''' Easy

:'''Mentor:''' Chad Windnagle

====Project: Trash Manager====

:'''Brief Explanation:''' Create a component that functions similarly to com_checkin that allows you to manage trash items across all tables.

:'''Expected Results:''' It should be able to pull records in 'trashed' status that have -2 as the value and allow selection of single deletion, mass deletion, deletion by table, etc. Include an integrated notification to users that they have trashed item.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL

:'''Difficulty:''' Medium

====Project: Data Dictionary====

:'''Brief Explanation:''' Create a data dictionary that will expand on current core database tables to add support for more commonly used data and will be supported on newly created Joomla databases. Also create a process for updating and managing the data dictionary, and document the current data model.

:'''Read more about this idea:'''
*[https://docs.google.com/document/d/1_a08yMHnzGWDw2nsBlu5Ztxxketq9Q8jrkqf8C3iUEg/edit Shared Data Dictionary for Joomla]

:'''Expected Results:''' A data dictionary will make it easier for different developers to standardize on where to create, read, update, and delete some commonly stored data (such as user profile information), instead of the current situation where multiple extensions may potentially duplicate the same data.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL

:'''Difficulty:''' Medium

====Project: Refactor Media Manager====

:'''Brief Explanation:''' The current media manager is outdated and limited. Refactor the media manager to include a better user interface, more robust functionality, and seemless integration for extensions to use. The improvements could include providing a folder tree, file property information, upload capabilities, move/rename files and folders, use of JImage for image basic processing (resize, crop).

:'''Expected Results:''' Refactor the Media Manager to improve the usability, functionality, and reusability of the extension.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL, Javascript

:'''Difficulty:''' Medium to Hard

===Joomla Platform===

The Joomla Platform allows for ideas that can work within the Joomla CMS, or could be completely separate applications that have no connection at all. The Joomla Platform allows for applications to be built for the command line, process daemons and the web. The follow list outlines some ideas that will be immediately useful for the Joomla Platform project that a student may consider taking on. In addition to PHP libraries, the Joomla Platform also ships with MooTools and project ideas can be related to client-side operations as well as server-side. One emphasis on this year's list is on the incorporation of packages for accessing web services, however other ideas for libraries and packages are welcome. In some instances multiple students may work on different aspects of the project. Two examples of this are unit testing and JStemmer.

References:
*[http://github.com/joomla/joomla-platform github Source Code]
*[http://developer.joomla.org/strategy.html Development Strategy]
*[http://groups.google.com/d/forum/joomla-dev-platform Developer Mailing List]

All code contributions must follow Joomla coding standards and include full unit test coverage.

====Project: Document Classes====

:'''Brief explanation:''' Create JCard, JCalendar and other extensible classes that will read and produce standards compliant documents of specific types (e.g. vCard,iCal).

:'''References:'''
* http://en.wikipedia.org/wiki/ICalendar
* http://www.imc.org/pdi/
* http://tools.ietf.org/html/rfc5545

:'''Knowledge Prerequisite:''' Joomla Platform, XML, web standards,

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A fully developed, unit tested and documented set of classes (specific number and choices will be finalized in discussion with the mentor and platform maintainers) and a simple platform application illustrating use.

====Project: Library to Compile and Compress Javascript and CSS Files====

:'''Brief explanation:''' Compiling and compressing javascript and CSS files can substantially the improve performance of a web site. Providing a package to do this will help the CMS and other web applications.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, javascript

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform package with testing and documentation.

====Project: JMailer====

:'''Brief explanation:''' Build out a JMailer class to replace PHPMailer in the platform. This should build upon preliminary work that has already been implemented and is available here.

:'''Knowledge Prerequisite:''' Joomla Platform, web standards, e-mail protocols.

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform package for JMailer that provides the same functionality as PHPMailer, with testing and documentation.

====Project: Social Package====

:'''Brief explanation:''' Over the last several years, social media has become a dominant force in online media. Based on the number of extensions interacting with various social media APIs, it would be logical to build a Social package for the Joomla! Platform that provides a common and simplified interface to post and retrieve data from various social media networks. JGitHub and its sub-classes can be used as an example in building this package.

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with social media APIs (Facebook, Twitter, Google+, etc.), OAuth

:'''Difficulty:''' Medium to Hard

:'''Mentor:''' Michael Babker

:'''Expected Results:''' A package of classes which can be used to interact with various social media APIs and can be further extended in the future for new APIs and endpoints.

====Project: JStemmer====

:'''Brief explanation:''' Currently the Joomla CMS includes only a Joomla stemmer for English while the Snowball stemmer is wrapped. We would like to move the English stemmer to the Joomla platform and make the class useful by adding Joomla stemmers for other languages.

:'''References:'''
* https://github.com/joomla/joomla-cms/tree/master/administrator/components/com_finder/helpers/indexer
* http://snowball.tartarus.org/
* http://en.wikipedia.org/wiki/Stemming

:'''Knowledge Prerequisite:''' Joomla Platform, language issues, web standards,

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform class for stemming with subclasses for a number of specific languages (number and specific languages to be determined in discussion with mentor and the search and translation teams). The final product should be fully documented and unit tested.

====Project: JCommerce====
:'''Brief explanation:''' Create a commerce class based on preliminary work that has been done.

:'''References:'''
* https://github.com/LouisLandry/joomla-platform/tree/commerce/libraries/joomla/commerce

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, web security, standards

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A completed commerce class (including documentation and tests) for cart management and interaction with payment processors.

====Project: JTranscode ====

:'''Brief explanation:''' Create a class for transcoding video using ffmpeg.

:'''References:'''
*http://ffmpeg.org/
*http://en.wikipedia.org/wiki/Transcoding

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, standards, media handling

:'''Difficulty:''' Medium to Hard

:'''Expected Results:'''

====Project: Extend JImage to work with IMagick ====
:'''Brief explanation:''' JImage is an important library added in late 2011. Extend it to work with Imagick.

:'''References:'''
*http://www.imagemagick.org/script/index.php
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/image

:'''Knowledge Prerequisite:''' Joomla Platform

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' Complete, documented and tested code to extend the JImage class to use Imagick

====Project: JGoogle Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Google APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://code.google.com/more/
*http://code.google.com/more/table/

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JFacebook Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Facebook APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://developers.facebook.com/docs/guides/web/
*http://www.pluralsight-training.net/microsoft/courses/TableOfContents?courseName=fb-platform

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JAmazonS3 Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating the Amazon S3 APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://aws.amazon.com/archives/Amazon-S3/123

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JRackspace Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Rackspace Cloud APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.rackspace.com/cloud/cloud_hosting_products/servers/api/

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JMediaWiki Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating MediaWiki APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.mediawiki.org/wiki/API:Main_page

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JOpenStreetMap Package ====
:'''Brief explanation:''' Implement a class for incorporating OpenStreetMap for both editing and using data.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.openstreetmap.org/
*http://wiki.openstreetmap.org/wiki/Databases_and_data_access_APIs
*http://wiki.openstreetmap.org/wiki/API
*http://wiki.openstreetmap.org/wiki/Databases_and_data_access_APIs

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs, databases, xml, geodata

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes for interacting with Open Street Map.

====Project: Platform Unit Testing====

:'''Brief explanation:''' The Joomla Platform has a good suite of automated Unit Tests, but code coverage is lacking in some areas. The goal of this project is to improve the code coverage by writing unit tests for the Joomla Platform.

:'''Expected Results:''' The student will be expected to review the current [http://developer.joomla.org/coverage/ code coverage report] for the Joomla Platform and write and agreed-upon number of unit tests with particular attention to packages that are below 50% coverage. Preference should be given to non-deprecated classes but the student may choose from either the core tree (/libraries/joomla) or the legacy tree (/libraries/legacy).

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

===Platform Applications===

The creation of useful platform applications that can also serve as exemplars for other platform developers is a third type of project. These applications, whether web or command line based, are built on the Joomla! Platform.

References:
*https://github.com/joomla/joomla-platform-examples
*https://github.com/joomla/joomla-platform

====Project: Platform Application to Create PHAR Packages====

:'''Brief explanation:''' Create a platform application that creates PHAR packages for each package in the Joomla Platform. The goal here is to make the platform accessible to developers in a modular fashion so that they can access only the packages they need for a given application.

:'''References:'''
*http://php.net/manual/en/intro.phar.php

:'''Expected Results:''' A working and documented application for creating PHAR packages.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP

:'''Difficulty:''' Medium to Hard

====Project: Platform Example or Building Block Applications====

:'''Brief explanation:''' The Platform Examples repository currently contains a number of very simple sample "Hello world!" applications. Create a number of example web and command line applications using the platform API that could be used as building blocks by developers building more complex applications. Examples would include authentication, cache, form, filesystem, http, and streams classes.

:'''Expected Results:''' A set of fully implemented Joomla Platform applications that can be easily adapted by developers. Specific applications should be listed in your proposal and will be finalized in discussion with the mentor. Ideally every platform package would have an example application, so there is room for multiple projects.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP

:'''Difficulty:''' Medium to Hard

====Project: Joomla Translations====

:'''Brief explanation:''' Create a platform application for management of the translation process, which will be a kind of Facebook Self-Translation App for Joomla! communities to have better translation.

:'''References:'''
:*[http://www.facebook.com/translations/ Facebook Self-Translation]
:*[http://localize.drupal.org localize.drupal.org]
:*[http://weblate.org/ weblate]

:'''Expected Results:''' The application will make better translations for Joomla! It will help non-English speaking translation teams to get feedback about translation quality from people, who speak the same language. So translation teams can involve more volunteers in translation process. It will help also extension developers to translate their software. It will enable ability to submit a new extension translation INI file in English and get the translated version from the translation teams.

:'''Knowledge Prerequisite:''' PHP, JavaScript, MySQL, Joomla! Framework

:'''Difficulty:''' Medium

:'''Mentor:''' Edvard Ananyan

====Project: Joomla Platform Application Directory====

:'''Brief explanation:''' The Joomla project has several directory sites dedicated to extensions for the Joomla CMS (the [http://extensions.joomla.org JED]) and free and commercial resources (the [http://resources.joomla.org JRD]). With the release of the Joomla Platform, and its particular attention to allowing other types of applications (not just the CMS), there is a need for a new website to act as a directory for these applications. The goal of this project is to build a new Joomla Platform application (not a Joomla component but a full application) to serve as this directory.

:'''Expected Results:''' The student will be expected to build a new web application based on JApplicationWeb and the new Universal Content Model (UCM) [see https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content] package loosely inline with the other Joomla directory sites (the JED and the JRD). This is expected to be a "phase 1" project where the features will include user registration (agreeing to terms) and login, simple information pages (like Joomla articles) and listing pages for Joomla Platform applications. Suitable fields will be required and should include such things as application type (command line application, daemon, web application, web service, etc), what the application does, how to get it and so forth. The student is not expected to design the final template but should look to [http://twitter.github.com/bootstrap/ Bootstrap] for basic inspiration. Simple categorization will also be required. Global search can be added if time permits.

:'''References:''' PHP, OOP

* https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content
* http://extensions.joomla.org/
* http://resources.joomla.org/
* https://github.com/eBaySF/joomla-platform/tree/content/docs/manual/en-US
:'''Knowledge Prerequisite:''' PHP, OOP

:'''Difficulty:''' Hard but very rewarding

====Project: Joomla Extension Directory====

:'''Brief explanation:''' In this project we would like to experiment with some radical ideas that could change from the ground up how directories such as the JED work (the [http://extensions.joomla.org JED]). Our intention is to try out the model of meritocracy and see if it is a valuable alternative to the current way directories operate. The goal of this project is to build a new Joomla Platform application (not a Joomla component but a full application) to serve as an example of such a model.

:'''Expected Results:''' The student will be expected to build a new web application based on JApplicationWeb and the new Universal Content Model (UCM) [see https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content] . This is expected to be a "phase 1" project where the features will include workflow, listing submit(that checks the code of the submitted extension for some security issues), listing reviews + implementing a good scoring algorithm. The student is not expected to design the final website but should look to [http://twitter.github.com/bootstrap/ Bootstrap] for basic inspiration.

:'''References:''' PHP, OOP

* The idea in more details https://docs.google.com/document/d/1qa57rZcp0oMpA1mCr3mpletenwcDkx8wbI2vv6GCRsY/edit
* https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content
* http://extensions.joomla.org/
* https://github.com/eBaySF/joomla-platform/tree/content/docs/manual/en-US
:'''Knowledge Prerequisite:''' PHP, OOP

:'''Difficulty:''' Hard but very rewarding

[[Category:Google Summer of Code 2012]]

Archived:GSOC 2012 Project Ideas

2012-03-22T13:24:49Z

THE AI:

{{RightTOC}}

==Welcome!==
Welcome to the Joomla! Google Summer of Code (GSoC) 2012 project ideas page. As we move forward with the 2012 version of the Joomla! GSoC, we will use this page to develop possible project ideas. Please note that anyone who is interested can participate in this process. You do not have to be a GSoC student or mentor to suggest possible project ideas. Please keep in mind that projects need to be realistically something that is able to be functionally completed by a student working full time for about eight weeks. Thanks!

Discussion of ideas and other GSoC related items is welcome on our Google Group: https://groups.google.com/forum/?fromgroups#!forum/joomla-gsoc-2012

If you are interested in serving as a mentor, please fill out the [https://docs.google.com/spreadsheet/viewform?formkey=dERlY0dxekFUWEg4ME1YZDhVMDhJMGc6MQ#gid=0 Mentor Application Form].

If you are interested in applying as a student please see our [https://docs.google.com/document/d/1s5chDv-hekOXwgNAjjF-YMQKRaisigasPk-ZCW5KgNQ/edit application template]. You will need to register with Google and submit through their GSOC program.

If you are interested in participating as a student please review the materials on applying that are available at [http://code.google.com/soc/ Google]. We strongly encourage you to ask questions about process and ideas on the mailing list.

* [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2012/userguide#depth_mentor Guide for Mentors]
* [http://www.google-melange.com/document/show/gsoc_program/google/gsoc2012/faqs Google Summer of Code™ 2012 Frequently Asked Questions]

==Ideas==

Opportunities exist for students to work with projects from either the Joomla CMS, the Joomla Platform or in some cases a combination of both.

In addition to this ideas list, the Joomla! Community is able to voice their opinion on features they would like to see via the [http://ideas.joomla.org/ Joomla! Idea Pool]. Those wishing to add ideas to this listing are encouraged to review the Idea Pool and base their idea on the input received there. You can also view the past lists for [http://docs.joomla.org/Summer_of_Code_2010_Project_Ideas 2010] and [http://docs.joomla.org/Summer_of_Code_2009_Project_Ideas 2009], which may be useful for reference. We ask that you keep ideas realistic for the time frame that students will have to complete their projects.

Unless a mentor has proposed a specific project, mentors from the mentor pool will be matched with student projects. However members of the mentor pool are available to answer questions on the Joomla GSoC mailing list.

===Joomla CMS===

* [http://github.com/joomla/joomla-cms Source Code]
* [http://groups.google.com/d/forum/joomla-dev-cms Developer Mailing List]

====Project: Language Installation====

:'''Brief Explanation:''' Create an interface to install language packs from a generated list of accredited language packs during Joomla installation and subsequently from the administrator interface, either the extension manager or the language manager.

:'''References:'''
* http://joomlacode.org/gf/project/jtranslation1_6/frs/
* https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/updater

:'''Expected Results:''' The goal is to have code implementing this functionally complete and in a format ready for testings by the Joomla Bug Squad as a new feature in the CMS using the normal new feature process.

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, web services

:'''Difficulty:''' Medium to Hard

====Project: CMS Unit Testing====

:'''Brief explanation:''' The Joomla CMS has its own set of classes that augment the Joomla platform but these are not well tested. The goal of this project is to improve the code coverage by writing unit tests for library classes specific to the Joomla CMS.

:'''Expected Results:''' The student will be expected to review the current code coverage for the Joomla CMS libraries (/libraries/cms) and write and agreed-upon number of unit tests with particular attention to packages and classes that are below 50% coverage.

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

====Project: Query optimization ====

:'''Brief explanation:''' Profile the queries in the CMS and optimize them, insuring that they remain database agnostic.

:'''References:'''
* https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/database
* http://en.wikipedia.org/wiki/SQL

:'''Expected Results:''' Measurable improvement in the performance of the CMS. The project will likely also result in contributions to JDatabaseQuery and other related classes in the Joomla Platform.

:'''Knowledge Prerequisite:''' SQL, Joomla Platform (JDatabase), ANSI standards.

:'''Difficulty:''' Medium

====Project: Batch processing management/scheduler====

:'''Brief explanation:''' Brief explanation:Manage batch job’s processing, create, schedule and run jobs, such as backup,virus scan, billing, reports, emailing and much more

:'''Expected Results:''' The student will be expected to build an O.S. independent solution that act as a wrapper to manage jobs, allowing to manage tasks from third party extensions too, in a easy way simplifying the Joomla webmaster life
See: http://en.wikipedia.org/wiki/Batch_processing

:'''Knowledge Prerequisite:''': PHP, Joomla CMS, Joomla Platform, Mysql, Operating Systems.

:'''Mentor:''': Nicola Galgano

====Project: Add Article Image support to Core Content Modules====

:'''Brief explanation:''' Joomla 2.5.x ships with several core content modules. These modules can display article lists or links. However they do not support bringing in article images. This project would be to make some minor code updates to all the core content modules to add article image support and parameters. Some basic parameters would be to show / hide the article image, specify a thumbnail size, enable or disable article links on the image, and whether or not to respect the image's proportion when resized as a thumbnail.

:'''Expected Results:''' The student will be expected to modify and update Joomla's core content modules and make modifications to the multiple files in the MVC structure to add parameters, and add additional code to the module's HTML output. The module should interface with the Joomla core class JImage as well to create the thumbnail image.

:'''Knowledge Prerequisite:''' PHP, Joomla! Framework

:'''Difficulty:''' Easy

:'''Mentor:''' Chad Windnagle

====Project: Trash Manager====

:'''Brief Explanation:''' Create a component that functions similarly to com_checkin that allows you to manage trash items across all tables.

:'''Expected Results:''' It should be able to pull records in 'trashed' status that have -2 as the value and allow selection of single deletion, mass deletion, deletion by table, etc. Include an integrated notification to users that they have trashed item.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL

:'''Difficulty:''' Medium

====Project: Data Dictionary====

:'''Brief Explanation:''' Create a data dictionary that will expand on current core database tables to add support for more commonly used data and will be supported on newly created Joomla databases. Also create a process for updating and managing the data dictionary, and document the current data model.

:'''Read more about this idea:'''
*[https://docs.google.com/document/d/1_a08yMHnzGWDw2nsBlu5Ztxxketq9Q8jrkqf8C3iUEg/edit Shared Data Dictionary for Joomla]

:'''Expected Results:''' A data dictionary will make it easier for different developers to standardize on where to create, read, update, and delete some commonly stored data (such as user profile information), instead of the current situation where multiple extensions may potentially duplicate the same data.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL

:'''Difficulty:''' Medium

====Project: Refactor Media Manager====

:'''Brief Explanation:''' The current media manager is outdated and limited. Refactor the media manager to include a better user interface, more robust functionality, and seemless integration for extensions to use. The improvements could include providing a folder tree, file property information, upload capabilities, move/rename files and folders, use of JImage for image basic processing (resize, crop).

:'''Expected Results:''' Refactor the Media Manager to improve the usability, functionality, and reusability of the extension.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL, Javascript

:'''Difficulty:''' Medium to Hard

===Joomla Platform===

The Joomla Platform allows for ideas that can work within the Joomla CMS, or could be completely separate applications that have no connection at all. The Joomla Platform allows for applications to be built for the command line, process daemons and the web. The follow list outlines some ideas that will be immediately useful for the Joomla Platform project that a student may consider taking on. In addition to PHP libraries, the Joomla Platform also ships with MooTools and project ideas can be related to client-side operations as well as server-side. One emphasis on this year's list is on the incorporation of packages for accessing web services, however other ideas for libraries and packages are welcome. In some instances multiple students may work on different aspects of the project. Two examples of this are unit testing and JStemmer.

References:
*[http://github.com/joomla/joomla-platform github Source Code]
*[http://developer.joomla.org/strategy.html Development Strategy]
*[http://groups.google.com/d/forum/joomla-dev-platform Developer Mailing List]

All code contributions must follow Joomla coding standards and include full unit test coverage.

====Project: Document Classes====

:'''Brief explanation:''' Create JCard, JCalendar and other extensible classes that will read and produce standards compliant documents of specific types (e.g. vCard,iCal).

:'''References:'''
* http://en.wikipedia.org/wiki/ICalendar
* http://www.imc.org/pdi/
* http://tools.ietf.org/html/rfc5545

:'''Knowledge Prerequisite:''' Joomla Platform, XML, web standards,

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A fully developed, unit tested and documented set of classes (specific number and choices will be finalized in discussion with the mentor and platform maintainers) and a simple platform application illustrating use.

====Project: Library to Compile and Compress Javascript and CSS Files====

:'''Brief explanation:''' Compiling and compressing javascript and CSS files can substantially the improve performance of a web site. Providing a package to do this will help the CMS and other web applications.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, javascript

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform package with testing and documentation.

====Project: JMailer====

:'''Brief explanation:''' Build out a JMailer class to replace PHPMailer in the platform. This should build upon preliminary work that has already been implemented and is available here.

:'''Knowledge Prerequisite:''' Joomla Platform, web standards, e-mail protocols.

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform package for JMailer that provides the same functionality as PHPMailer, with testing and documentation.

====Project: Social Package====

:'''Brief explanation:''' Over the last several years, social media has become a dominant force in online media. Based on the number of extensions interacting with various social media APIs, it would be logical to build a Social package for the Joomla! Platform that provides a common and simplified interface to post and retrieve data from various social media networks. JGitHub and its sub-classes can be used as an example in building this package.

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with social media APIs (Facebook, Twitter, Google+, etc.), OAuth

:'''Difficulty:''' Medium to Hard

:'''Mentor:''' Michael Babker

:'''Expected Results:''' A package of classes which can be used to interact with various social media APIs and can be further extended in the future for new APIs and endpoints.

====Project: JStemmer====

:'''Brief explanation:''' Currently the Joomla CMS includes only a Joomla stemmer for English while the Snowball stemmer is wrapped. We would like to move the English stemmer to the Joomla platform and make the class useful by adding Joomla stemmers for other languages.

:'''References:'''
* https://github.com/joomla/joomla-cms/tree/master/administrator/components/com_finder/helpers/indexer
* http://snowball.tartarus.org/
* http://en.wikipedia.org/wiki/Stemming

:'''Knowledge Prerequisite:''' Joomla Platform, language issues, web standards,

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform class for stemming with subclasses for a number of specific languages (number and specific languages to be determined in discussion with mentor and the search and translation teams). The final product should be fully documented and unit tested.

====Project: JCommerce====
:'''Brief explanation:''' Create a commerce class based on preliminary work that has been done.

:'''References:'''
* https://github.com/LouisLandry/joomla-platform/tree/commerce/libraries/joomla/commerce

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, web security, standards

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A completed commerce class (including documentation and tests) for cart management and interaction with payment processors.

====Project: JTranscode ====

:'''Brief explanation:''' Create a class for transcoding video using ffmpeg.

:'''References:'''
*http://ffmpeg.org/
*http://en.wikipedia.org/wiki/Transcoding

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, standards, media handling

:'''Difficulty:''' Medium to Hard

:'''Expected Results:'''

====Project: Extend JImage to work with IMagick ====
:'''Brief explanation:''' JImage is an important library added in late 2011. Extend it to work with Imagick.

:'''References:'''
*http://www.imagemagick.org/script/index.php
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/image

:'''Knowledge Prerequisite:''' Joomla Platform

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' Complete, documented and tested code to extend the JImage class to use Imagick

====Project: JGoogle Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Google APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://code.google.com/more/
*http://code.google.com/more/table/

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JFacebook Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Facebook APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://developers.facebook.com/docs/guides/web/
*http://www.pluralsight-training.net/microsoft/courses/TableOfContents?courseName=fb-platform

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JAmazonS3 Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating the Amazon S3 APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://aws.amazon.com/archives/Amazon-S3/123

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JRackspace Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Rackspace Cloud APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.rackspace.com/cloud/cloud_hosting_products/servers/api/

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JMediaWiki Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating MediaWiki APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.mediawiki.org/wiki/API:Main_page

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JOpenStreetMap Package ====
:'''Brief explanation:''' Implement a class for incorporating OpenStreetMap for both editing and using data.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.openstreetmap.org/
*http://wiki.openstreetmap.org/wiki/Databases_and_data_access_APIs
*http://wiki.openstreetmap.org/wiki/API
*http://wiki.openstreetmap.org/wiki/Databases_and_data_access_APIs

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs, databases, xml, geodata

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes for interacting with Open Street Map.

====Project: Platform Unit Testing====

:'''Brief explanation:''' The Joomla Platform has a good suite of automated Unit Tests, but code coverage is lacking in some areas. The goal of this project is to improve the code coverage by writing unit tests for the Joomla Platform.

:'''Expected Results:''' The student will be expected to review the current [http://developer.joomla.org/coverage/ code coverage report] for the Joomla Platform and write and agreed-upon number of unit tests with particular attention to packages that are below 50% coverage. Preference should be given to non-deprecated classes but the student may choose from either the core tree (/libraries/joomla) or the legacy tree (/libraries/legacy).

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

===Platform Applications===

The creation of useful platform applications that can also serve as exemplars for other platform developers is a third type of project. These applications, whether web or command line based, are built on the Joomla! Platform.

References:
*https://github.com/joomla/joomla-platform-examples
*https://github.com/joomla/joomla-platform

====Project: Platform Application to Create PHAR Packages====

:'''Brief explanation:''' Create a platform application that creates PHAR packages for each package in the Joomla Platform. The goal here is to make the platform accessible to developers in a modular fashion so that they can access only the packages they need for a given application.

:'''References:'''
*http://php.net/manual/en/intro.phar.php

:'''Expected Results:''' A working and documented application for creating PHAR packages.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP

:'''Difficulty:''' Medium to Hard

====Project: Platform Example or Building Block Applications====

:'''Brief explanation:''' The Platform Examples repository currently contains a number of very simple sample "Hello world!" applications. Create a number of example web and command line applications using the platform API that could be used as building blocks by developers building more complex applications. Examples would include authentication, cache, form, filesystem, http, and streams classes.

:'''Expected Results:''' A set of fully implemented Joomla Platform applications that can be easily adapted by developers. Specific applications should be listed in your proposal and will be finalized in discussion with the mentor. Ideally every platform package would have an example application, so there is room for multiple projects.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP

:'''Difficulty:''' Medium to Hard

====Project: Joomla Translations====

:'''Brief explanation:''' Create a platform application for management of the translation process, which will be a kind of Facebook Self-Translation App for Joomla! communities to have better translation.

:'''References:'''
:*[http://www.facebook.com/translations/ Facebook Self-Translation]
:*[http://localize.drupal.org localize.drupal.org]
:*[http://weblate.org/ weblate]

:'''Expected Results:''' The application will make better translations for Joomla! It will help non-English speaking translation teams to get feedback about translation quality from people, who speak the same language. So translation teams can involve more volunteers in translation process. It will help also extension developers to translate their software. It will enable ability to submit a new extension translation INI file in English and get the translated version from the translation teams.

:'''Knowledge Prerequisite:''' PHP, JavaScript, MySQL, Joomla! Framework

:'''Difficulty:''' Medium

:'''Mentor:''' Edvard Ananyan

====Project: Joomla Platform Application Directory====

:'''Brief explanation:''' The Joomla project has several directory sites dedicated to extensions for the Joomla CMS (the [http://extensions.joomla.org JED]) and free and commercial resources (the [http://resources.joomla.org JRD]). With the release of the Joomla Platform, and its particular attention to allowing other types of applications (not just the CMS), there is a need for a new website to act as a directory for these applications. The goal of this project is to build a new Joomla Platform application (not a Joomla component but a full application) to serve as this directory.

:'''Expected Results:''' The student will be expected to build a new web application based on JApplicationWeb and the new Universal Content Model (UCM) [see https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content] package loosely inline with the other Joomla directory sites (the JED and the JRD). This is expected to be a "phase 1" project where the features will include user registration (agreeing to terms) and login, simple information pages (like Joomla articles) and listing pages for Joomla Platform applications. Suitable fields will be required and should include such things as application type (command line application, daemon, web application, web service, etc), what the application does, how to get it and so forth. The student is not expected to design the final template but should look to [http://twitter.github.com/bootstrap/ Bootstrap] for basic inspiration. Simple categorization will also be required. Global search can be added if time permits.

:'''References:''' PHP, OOP

* https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content
* http://extensions.joomla.org/
* http://resources.joomla.org/
* https://github.com/eBaySF/joomla-platform/tree/content/docs/manual/en-US
:'''Knowledge Prerequisite:''' PHP, OOP

:'''Difficulty:''' Hard but very rewarding

====Project: Joomla Extension Directory====

:'''Brief explanation:''' In this project we would like to experiment with some radical ideas that could from the ground up how the directories such as the JED works (the [http://extensions.joomla.org JED]). Our intention is to try out the model of meritocracy and see if it is a valuable alternative to the current way the directories work. The goal of this project is to build a new Joomla Platform application (not a Joomla component but a full application) to serve as this directory.

:'''Expected Results:''' The student will be expected to build a new web application based on JApplicationWeb and the new Universal Content Model (UCM) [see https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content] . This is expected to be a "phase 1" project where the features will include workflow, listing submit(that checks the code of the submitted extension for some security issues), listing reviews + implementing a good scoring algorithm. The student is not expected to design the final website but should look to [http://twitter.github.com/bootstrap/ Bootstrap] for basic inspiration.

:'''References:''' PHP, OOP

* The idea in more details https://docs.google.com/document/d/1qa57rZcp0oMpA1mCr3mpletenwcDkx8wbI2vv6GCRsY/edit
* https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content
* http://extensions.joomla.org/
* https://github.com/eBaySF/joomla-platform/tree/content/docs/manual/en-US
:'''Knowledge Prerequisite:''' PHP, OOP

:'''Difficulty:''' Hard but very rewarding

[[Category:Google Summer of Code 2012]]

Archived:GSOC 2012 Project Ideas

2012-03-21T12:24:41Z

THE AI:

{{RightTOC}}

==Welcome!==
Welcome to the Joomla! Google Summer of Code (GSoC) 2012 project ideas page. As we move forward with the 2012 version of the Joomla! GSoC, we will use this page to develop possible project ideas. Please note that anyone who is interested can participate in this process. You do not have to be a GSoC student or mentor to suggest possible project ideas. Please keep in mind that projects need to be realistically something that is able to be functionally completed by a student working full time for about eight weeks. Thanks!

Discussion of ideas and other GSoC related items is welcome on our Google Group: https://groups.google.com/forum/?fromgroups#!forum/joomla-gsoc-2012

If you are interested in serving as a mentor, please fill out the [https://docs.google.com/spreadsheet/viewform?formkey=dERlY0dxekFUWEg4ME1YZDhVMDhJMGc6MQ#gid=0 Mentor Application Form].

If you are interested in applying as a student please see our [https://docs.google.com/document/d/1s5chDv-hekOXwgNAjjF-YMQKRaisigasPk-ZCW5KgNQ/edit application template]. You will need to register with Google and submit through their GSOC program.

If you are interested in participating as a student please review the materials on applying that are available at [http://code.google.com/soc/ Google]. We strongly encourage you to ask questions about process and ideas on the mailing list.

* [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2012/userguide#depth_mentor Guide for Mentors]
* [http://www.google-melange.com/document/show/gsoc_program/google/gsoc2012/faqs Google Summer of Code™ 2012 Frequently Asked Questions]

==Ideas==

Opportunities exist for students to work with projects from either the Joomla CMS, the Joomla Platform or in some cases a combination of both.

In addition to this ideas list, the Joomla! Community is able to voice their opinion on features they would like to see via the [http://ideas.joomla.org/ Joomla! Idea Pool]. Those wishing to add ideas to this listing are encouraged to review the Idea Pool and base their idea on the input received there. You can also view the past lists for [http://docs.joomla.org/Summer_of_Code_2010_Project_Ideas 2010] and [http://docs.joomla.org/Summer_of_Code_2009_Project_Ideas 2009], which may be useful for reference. We ask that you keep ideas realistic for the time frame that students will have to complete their projects.

Unless a mentor has proposed a specific project, mentors from the mentor pool will be matched with student projects. However members of the mentor pool are available to answer questions on the Joomla GSoC mailing list.

===Joomla CMS===

* [http://github.com/joomla/joomla-cms Source Code]
* [http://groups.google.com/d/forum/joomla-dev-cms Developer Mailing List]

====Project: Language Installation====

:'''Brief Explanation:''' Create an interface to install language packs from a generated list of accredited language packs during Joomla installation and subsequently from the administrator interface, either the extension manager or the language manager.

:'''References:'''
* http://joomlacode.org/gf/project/jtranslation1_6/frs/
* https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/updater

:'''Expected Results:''' The goal is to have code implementing this functionally complete and in a format ready for testings by the Joomla Bug Squad as a new feature in the CMS using the normal new feature process.

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, web services

:'''Difficulty:''' Medium to Hard

====Project: CMS Unit Testing====

:'''Brief explanation:''' The Joomla CMS has its own set of classes that augment the Joomla platform but these are not well tested. The goal of this project is to improve the code coverage by writing unit tests for library classes specific to the Joomla CMS.

:'''Expected Results:''' The student will be expected to review the current code coverage for the Joomla CMS libraries (/libraries/cms) and write and agreed-upon number of unit tests with particular attention to packages and classes that are below 50% coverage.

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

====Project: Query optimization ====

:'''Brief explanation:''' Profile the queries in the CMS and optimize them, insuring that they remain database agnostic.

:'''References:'''
* https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/database
* http://en.wikipedia.org/wiki/SQL

:'''Expected Results:''' Measurable improvement in the performance of the CMS. The project will likely also result in contributions to JDatabaseQuery and other related classes in the Joomla Platform.

:'''Knowledge Prerequisite:''' SQL, Joomla Platform (JDatabase), ANSI standards.

:'''Difficulty:''' Medium

====Project: Batch processing management/scheduler====

:'''Brief explanation:''' Brief explanation:Manage batch job’s processing, create, schedule and run jobs, such as backup,virus scan, billing, reports, emailing and much more

:'''Expected Results:''' The student will be expected to build an O.S. independent solution that act as a wrapper to manage jobs, allowing to manage tasks from third party extensions too, in a easy way simplifying the Joomla webmaster life
See: http://en.wikipedia.org/wiki/Batch_processing

:'''Knowledge Prerequisite:''': PHP, Joomla CMS, Joomla Platform, Mysql, Operating Systems.

:'''Mentor:''': Nicola Galgano

====Project: Add Article Image support to Core Content Modules====

:'''Brief explanation:''' Joomla 2.5.x ships with several core content modules. These modules can display article lists or links. However they do not support bringing in article images. This project would be to make some minor code updates to all the core content modules to add article image support and parameters. Some basic parameters would be to show / hide the article image, specify a thumbnail size, enable or disable article links on the image, and whether or not to respect the image's proportion when resized as a thumbnail.

:'''Expected Results:''' The student will be expected to modify and update Joomla's core content modules and make modifications to the multiple files in the MVC structure to add parameters, and add additional code to the module's HTML output. The module should interface with the Joomla core class JImage as well to create the thumbnail image.

:'''Knowledge Prerequisite:''' PHP, Joomla! Framework

:'''Difficulty:''' Easy

:'''Mentor:''' Chad Windnagle

====Project: Trash Manager====

:'''Brief Explanation:''' Create a component that functions similarly to com_checkin that allows you to manage trash items across all tables.

:'''Expected Results:''' It should be able to pull records in 'trashed' status that have -2 as the value and allow selection of single deletion, mass deletion, deletion by table, etc. Include an integrated notification to users that they have trashed item.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL

:'''Difficulty:''' Medium

====Project: Data Dictionary====

:'''Brief Explanation:''' Create a data dictionary that will expand on current core database tables to add support for more commonly used data and will be supported on newly created Joomla databases. Also create a process for updating and managing the data dictionary, and document the current data model.

:'''Read more about this idea:'''
*[https://docs.google.com/document/d/1_a08yMHnzGWDw2nsBlu5Ztxxketq9Q8jrkqf8C3iUEg/edit Shared Data Dictionary for Joomla]

:'''Expected Results:''' A data dictionary will make it easier for different developers to standardize on where to create, read, update, and delete some commonly stored data (such as user profile information), instead of the current situation where multiple extensions may potentially duplicate the same data.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL

:'''Difficulty:''' Medium

====Project: Refactor Media Manager====

:'''Brief Explanation:''' The current media manager is outdated and limited. Refactor the media manager to include a better user interface, more robust functionality, and seemless integration for extensions to use. The improvements could include providing a folder tree, file property information, upload capabilities, move/rename files and folders, use of JImage for image basic processing (resize, crop).

:'''Expected Results:''' Refactor the Media Manager to improve the usability, functionality, and reusability of the extension.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, MySQL, Javascript

:'''Difficulty:''' Medium to Hard

===Joomla Platform===

The Joomla Platform allows for ideas that can work within the Joomla CMS, or could be completely separate applications that have no connection at all. The Joomla Platform allows for applications to be built for the command line, process daemons and the web. The follow list outlines some ideas that will be immediately useful for the Joomla Platform project that a student may consider taking on. In addition to PHP libraries, the Joomla Platform also ships with MooTools and project ideas can be related to client-side operations as well as server-side. One emphasis on this year's list is on the incorporation of packages for accessing web services, however other ideas for libraries and packages are welcome. In some instances multiple students may work on different aspects of the project. Two examples of this are unit testing and JStemmer.

References:
*[http://github.com/joomla/joomla-platform github Source Code]
*[http://developer.joomla.org/strategy.html Development Strategy]
*[http://groups.google.com/d/forum/joomla-dev-platform Developer Mailing List]

All code contributions must follow Joomla coding standards and include full unit test coverage.

====Project: Document Classes====

:'''Brief explanation:''' Create JCard, JCalendar and other extensible classes that will read and produce standards compliant documents of specific types (e.g. vCard,iCal).

:'''References:'''
* http://en.wikipedia.org/wiki/ICalendar
* http://www.imc.org/pdi/
* http://tools.ietf.org/html/rfc5545

:'''Knowledge Prerequisite:''' Joomla Platform, XML, web standards,

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A fully developed, unit tested and documented set of classes (specific number and choices will be finalized in discussion with the mentor and platform maintainers) and a simple platform application illustrating use.

====Project: Library to Compile and Compress Javascript and CSS Files====

:'''Brief explanation:''' Compiling and compressing javascript and CSS files can substantially the improve performance of a web site. Providing a package to do this will help the CMS and other web applications.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP, javascript

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform package with testing and documentation.

====Project: JMailer====

:'''Brief explanation:''' Build out a JMailer class to replace PHPMailer in the platform. This should build upon preliminary work that has already been implemented and is available here.

:'''Knowledge Prerequisite:''' Joomla Platform, web standards, e-mail protocols.

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform package for JMailer that provides the same functionality as PHPMailer, with testing and documentation.

====Project: Social Package====

:'''Brief explanation:''' Over the last several years, social media has become a dominant force in online media. Based on the number of extensions interacting with various social media APIs, it would be logical to build a Social package for the Joomla! Platform that provides a common and simplified interface to post and retrieve data from various social media networks. JGitHub and its sub-classes can be used as an example in building this package.

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with social media APIs (Facebook, Twitter, Google+, etc.), OAuth

:'''Difficulty:''' Medium to Hard

:'''Mentor:''' Michael Babker

:'''Expected Results:''' A package of classes which can be used to interact with various social media APIs and can be further extended in the future for new APIs and endpoints.

====Project: JStemmer====

:'''Brief explanation:''' Currently the Joomla CMS includes only a Joomla stemmer for English while the Snowball stemmer is wrapped. We would like to move the English stemmer to the Joomla platform and make the class useful by adding Joomla stemmers for other languages.

:'''References:'''
* https://github.com/joomla/joomla-cms/tree/master/administrator/components/com_finder/helpers/indexer
* http://snowball.tartarus.org/
* http://en.wikipedia.org/wiki/Stemming

:'''Knowledge Prerequisite:''' Joomla Platform, language issues, web standards,

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A platform class for stemming with subclasses for a number of specific languages (number and specific languages to be determined in discussion with mentor and the search and translation teams). The final product should be fully documented and unit tested.

====Project: JCommerce====
:'''Brief explanation:''' Create a commerce class based on preliminary work that has been done.

:'''References:'''
* https://github.com/LouisLandry/joomla-platform/tree/commerce/libraries/joomla/commerce

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, web security, standards

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A completed commerce class (including documentation and tests) for cart management and interaction with payment processors.

====Project: JTranscode ====

:'''Brief explanation:''' Create a class for transcoding video using ffmpeg.

:'''References:'''
*http://ffmpeg.org/
*http://en.wikipedia.org/wiki/Transcoding

:'''Knowledge Prerequisite:''' Joomla Platform, JSON, standards, media handling

:'''Difficulty:''' Medium to Hard

:'''Expected Results:'''

====Project: Extend JImage to work with IMagick ====
:'''Brief explanation:''' JImage is an important library added in late 2011. Extend it to work with Imagick.

:'''References:'''
*http://www.imagemagick.org/script/index.php
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/image

:'''Knowledge Prerequisite:''' Joomla Platform

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' Complete, documented and tested code to extend the JImage class to use Imagick

====Project: JGoogle Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Google APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://code.google.com/more/
*http://code.google.com/more/table/

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JFacebook Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Facebook APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://developers.facebook.com/docs/guides/web/
*http://www.pluralsight-training.net/microsoft/courses/TableOfContents?courseName=fb-platform

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JAmazonS3 Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating the Amazon S3 APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://aws.amazon.com/archives/Amazon-S3/123

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JRackspace Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating Rackspace Cloud APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.rackspace.com/cloud/cloud_hosting_products/servers/api/

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JMediaWiki Package ====
:'''Brief explanation:''' Working from the model of JGithub, implement a class for incorporating MediaWiki APIs.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.mediawiki.org/wiki/API:Main_page

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes and tests for API client code for web services.

====Project: JOpenStreetMap Package ====
:'''Brief explanation:''' Implement a class for incorporating OpenStreetMap for both editing and using data.

:'''References:'''
*https://github.com/joomla/joomla-platform/tree/staging/libraries/joomla/github
*http://www.openstreetmap.org/
*http://wiki.openstreetmap.org/wiki/Databases_and_data_access_APIs
*http://wiki.openstreetmap.org/wiki/API
*http://wiki.openstreetmap.org/wiki/Databases_and_data_access_APIs

:'''Knowledge Prerequisite:''' Joomla Platform, familiarity with working with APIs, databases, xml, geodata

:'''Difficulty:''' Medium to Hard

:'''Expected Results:''' A set of classes for interacting with Open Street Map.

====Project: Platform Unit Testing====

:'''Brief explanation:''' The Joomla Platform has a good suite of automated Unit Tests, but code coverage is lacking in some areas. The goal of this project is to improve the code coverage by writing unit tests for the Joomla Platform.

:'''Expected Results:''' The student will be expected to review the current [http://developer.joomla.org/coverage/ code coverage report] for the Joomla Platform and write and agreed-upon number of unit tests with particular attention to packages that are below 50% coverage. Preference should be given to non-deprecated classes but the student may choose from either the core tree (/libraries/joomla) or the legacy tree (/libraries/legacy).

:'''Knowledge Prerequisite:''' PHP, PHPUnit

:'''Difficulty:''' Medium

===Platform Applications===

The creation of useful platform applications that can also serve as exemplars for other platform developers is a third type of project. These applications, whether web or command line based, are built on the Joomla! Platform.

References:
*https://github.com/joomla/joomla-platform-examples
*https://github.com/joomla/joomla-platform

====Project: Platform Application to Create PHAR Packages====

:'''Brief explanation:''' Create a platform application that creates PHAR packages for each package in the Joomla Platform. The goal here is to make the platform accessible to developers in a modular fashion so that they can access only the packages they need for a given application.

:'''References:'''
*http://php.net/manual/en/intro.phar.php

:'''Expected Results:''' A working and documented application for creating PHAR packages.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP

:'''Difficulty:''' Medium to Hard

====Project: Platform Example or Building Block Applications====

:'''Brief explanation:''' The Platform Examples repository currently contains a number of very simple sample "Hello world!" applications. Create a number of example web and command line applications using the platform API that could be used as building blocks by developers building more complex applications. Examples would include authentication, cache, form, filesystem, http, and streams classes.

:'''Expected Results:''' A set of fully implemented Joomla Platform applications that can be easily adapted by developers. Specific applications should be listed in your proposal and will be finalized in discussion with the mentor. Ideally every platform package would have an example application, so there is room for multiple projects.

:'''Knowledge Prerequisite:''' Joomla Platform, PHP

:'''Difficulty:''' Medium to Hard

====Project: Joomla Translations====

:'''Brief explanation:''' Create a platform application for management of the translation process, which will be a kind of Facebook Self-Translation App for Joomla! communities to have better translation.

:'''References:'''
:*[http://www.facebook.com/translations/ Facebook Self-Translation]
:*[http://localize.drupal.org localize.drupal.org]
:*[http://weblate.org/ weblate]

:'''Expected Results:''' The application will make better translations for Joomla! It will help non-English speaking translation teams to get feedback about translation quality from people, who speak the same language. So translation teams can involve more volunteers in translation process. It will help also extension developers to translate their software. It will enable ability to submit a new extension translation INI file in English and get the translated version from the translation teams.

:'''Knowledge Prerequisite:''' PHP, JavaScript, MySQL, Joomla! Framework

:'''Difficulty:''' Medium

:'''Mentor:''' Edvard Ananyan

====Project: Joomla Platform Application Directory====

:'''Brief explanation:''' The Joomla project has several directory sites dedicated to extensions for the Joomla CMS (the [http://extensions.joomla.org JED]) and free and commercial resources (the [http://resources.joomla.org JRD]). With the release of the Joomla Platform, and its particular attention to allowing other types of applications (not just the CMS), there is a need for a new website to act as a directory for these applications. The goal of this project is to build a new Joomla Platform application (not a Joomla component but a full application) to serve as this directory.

:'''Expected Results:''' The student will be expected to build a new web application based on JApplicationWeb and the new Universal Content Model (UCM) [see https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content] package loosely inline with the other Joomla directory sites (the JED and the JRD). This is expected to be a "phase 1" project where the features will include user registration (agreeing to terms) and login, simple information pages (like Joomla articles) and listing pages for Joomla Platform applications. Suitable fields will be required and should include such things as application type (command line application, daemon, web application, web service, etc), what the application does, how to get it and so forth. The student is not expected to design the final template but should look to [http://twitter.github.com/bootstrap/ Bootstrap] for basic inspiration. Simple categorization will also be required. Global search can be added if time permits.

:'''References:''' PHP, OOP

* https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content
* http://extensions.joomla.org/
* http://resources.joomla.org/
* https://github.com/eBaySF/joomla-platform/tree/content/docs/manual/en-US
:'''Knowledge Prerequisite:''' PHP, OOP

:'''Difficulty:''' Hard but very rewarding

====Project: Joomla Extension Directory====

:'''Brief explanation:''' In this project we would like to experiment with some radical ideas and change from the ground up how the JED works (the [http://extensions.joomla.org JED]). Our intention is to experiment with the model of meritocracy and see if it is a valuable alternative to the current way the JED works. The goal of this project is to build a new Joomla Platform application (not a Joomla component but a full application) to serve as this directory.

:'''Expected Results:''' The student will be expected to build a new web application based on JApplicationWeb and the new Universal Content Model (UCM) [see https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content] . This is expected to be a "phase 1" project where the features will include workflow, listing submit(that checks the code of the submitted extension for some security issues), listing reviews + implementing a good scoring algorithm. The student is not expected to design the final website but should look to [http://twitter.github.com/bootstrap/ Bootstrap] for basic inspiration.

:'''References:''' PHP, OOP

* The idea in more details https://docs.google.com/document/d/1qa57rZcp0oMpA1mCr3mpletenwcDkx8wbI2vv6GCRsY/edit
* https://github.com/eBaySF/joomla-platform/tree/content/libraries/joomla/content
* http://extensions.joomla.org/
* https://github.com/eBaySF/joomla-platform/tree/content/docs/manual/en-US
:'''Knowledge Prerequisite:''' PHP, OOP

:'''Difficulty:''' Hard but very rewarding

[[Category:Google Summer of Code 2012]]

Talk:Creating clickable background images using CSS

2009-04-02T10:49:01Z

THE AI: New page: The second example seems not to work. http://haacked.com/archive/2006/01/13/ClickableBackgroundImagesViaCSS.aspx we have to remove the visibility:hidden

The second example seems not to work.

http://haacked.com/archive/2006/01/13/ClickableBackgroundImagesViaCSS.aspx

we have to remove the visibility:hidden

Joomla! Extension Directory FAQs

2009-03-10T06:59:00Z

THE AI:

{{review}}

===How do I list my extension in the extensions site?===
Information on how to list extensions in the extensions site is available here:
http://extensions.joomla.org/content/view/15/63/

===What extension is used to manage extensions.joomla.org?===
It is a customized version of Mosets Tree (a commercial component you can find in the Joomla! Extensions Directory ).

===Why was my extension rejected from being listed?===
Some of the common reasons extensions are rejected are because of:
*logo violations
*extension cannot be downloaded or found on the site
*extension does not install

===How can I help the extension submission process?===
There are several ways you can help the extension submission process go faster and smoother.
As you may know, the Joomla! Extension Directory is supported by volunteers and it takes time to go through all the extensions.
To make things easier:
*Make sure your download link leads directly to the download page. It makes downloading and testing the extension a whole lot easier.
*Make sure a front-end/public/guest user can actually download the extension.
*Test your extension to make sure the package can be installed.
*If you have use the Joomla! logo anywhere, make sure it follows the logo guidelines.
*If you need to make changes to your extension listing and it has not been published, do not submit another application. Removing duplicates takes up precious time. Instead, either email your changes to [mailto:team@extensions.joomla.org]team@extensions.joomla.org with detailed information about your extension or wait until your extension is published.

===Why was my review of XYZ extension removed and/or edited?===
*Spam and/or self-promotion.
*Feature requests. Send feature requests to the developer.
*Support requests. Send support requests to the developer.
*You state that you haven't used the extension.
*Putting some type of code. The review section doesn't like code languages.

===How do I contact the Joomla! Extension Directory editors?===
The editors can be contacted through the Extension Directory forum or by mail team@extensions.joomla.org

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

Accessing the database using JDatabase

2009-02-13T10:11:05Z

THE AI: /* loadObject() */

J1.5:Latest News module with date

2008-10-05T09:31:59Z

THE AI:

You need two files: /modules/mod_latesnews/helper.php and /modules/mod_latesnews/tmpl/default.php

In the helper.php, add the

<source lang="php">
$lists[$i]->creationdate = JHTML::_('date', $row->created, JText::_('DATE_FORMAT_LC4'));
</source>

line to the bottom, so:

<source lang="php">
foreach ( $rows as $row )
{
$lists[$i]->link = JRoute::_(ContentHelperRoute::getArticleRoute($row->slug, $row->catslug, $row->sectionid));
$lists[$i]->text = htmlspecialchars( $row->title );
$lists[$i]->creationdate = JHTML::_('date', $row->created, JText::_('DATE_FORMAT_LC4');
$i++;
}
</source>

Now when the dates are collected with the mysql query, you need to add them to the default.php. Change this code

<source lang="php">
<a href="<?php echo $item->link; ?>" class="latestnews<?php echo $params->get('moduleclass_sfx'); ?>">
<?php echo $item->text .'<br />'.$item->creationdate; ?></a>
</source>

to

<source lang="php">
<a href="<?php echo $item->link; ?>" class="latestnews<?php echo $params->get('moduleclass_sfx'); ?>">
<?php echo $item->text; ?></a>
</source>

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