Joomla! Documentation - User contributions [en]

Talk:Tag form field type

2020-01-22T13:10:40Z

ADaneInSpain: Created page with "How is "mode" optional? Surely is must be either "ajax" or "nested" and how is it translatable?"

How is "mode" optional? Surely is must be either "ajax" or "nested" and how is it translatable?

J3.x:User Action Logs

2019-09-11T08:01:33Z

ADaneInSpain: Made code examples all assume that we 'use \Joomla\CMS\Factory' as there was inconsistancy

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=3.9}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=<translate>
Tutorial 
How to Use the New Action Logging System</translate>}}
<translate>

As of Joomla 3.9, Joomla introduced an action logging system.</translate> 

<translate> This system is the finalization of the [https://magazine.joomla.org/issues/issue-aug-2016/item/3111-gsoc-recording-actions-logs-accessible-by-super-admin-status-update "Recording Action Logs" project from GSoC 2016]. This system provides an infrastructure to create an audit log of activity performed on a website and can be fine tuned to the site admin's preferences. Extensions are able to hook into this system to add custom messages or have the system process standard CRUD actions.</translate>
 
<translate>

In this tutorial, you will find information on how to set up this new system.</translate>

'''<translate> Note: Only Super Users have access to the Action Logging system.</translate>'''
<translate>
==Component== 
</translate>
<translate>
===User Actions Log Dashboard=== 
</translate>
<translate> Navigate to {{rarr|Users,User Actions Log}} to access the dashboard.</translate>

[[Image:Joomla-39-action-logs-dashboard-<translate> en</translate>.png|800px]]

<translate> From this screen a Super User has a global overview of all activities performed on a site by users and has the ability to review, export, delete and purge entries.</translate>

<translate>
To learn more, please see:
*[[S:MyLanguage/Help38:Components_Actionlogs|User Actions Log interface]]
*[[S:MyLanguage/Help38:Components_User_Actionlogs_Options| User Actions Log Options]]</translate>

<translate>
==Plugin== 
</translate>
<translate>
===System - User Actions Log=== 
</translate>
<translate> Once enabled, this plugin allows to define the number of days after which the logs will be deleted.</translate>

<translate>
===Action Log=== 
</translate>
<translate> Once enabled, this plugin allows to record the actions of users for the core extensions.</translate>

<translate>
===Privacy - Action Logs=== 
</translate>
<translate> Once enabled, this plugin allows to export the action log data for a user's privacy request.</translate>

<translate>
==Module== 
</translate>

<translate>
===Action Logs - Latest Module=== 
</translate>
<translate> This admin module shows on the control panel a list of the latest actions performed on a site.</translate>

[[Image:Joomla-39-action-logs-latest-module-<translate> en</translate>.png|800px]]

<translate> '''Note:''' The module is not displayed by default on sites upgrading to Joomla 3.9. In order to display it on your control panel, navigate to {{rarr|Extensions,Manage,Manage,Enable the System - User Actions Log plugin}} and then go to {{rarr|Extensions,Modules,Administrator,New,Action Logs-Latest}}</translate>

<translate> Please see also: [[S:MyLanguage/Help38:Extensions_Module_Manager_Admin_Latestactions|Latest Actions Admin Module]].</translate>

<translate>
==How to hook an extension to the system== 
</translate>
<translate> Please feel free to edit this section by improving or correcting it.</translate>

<noinclude>
===Component Installation Script===
</noinclude>
<translate> Add the extension to the table (#__action_logs_extensions) so that it will appear in the configuration of User Action Logs.</translate> 
<source lang="php">
$extension = 'com_mycomponent';
$db = Factory::getDbo();
$db->setQuery(' INSERT into #__action_logs_extensions (extension) VALUES ('.$db->Quote($extension).') ' );
try {
// If it fails, it will throw a RuntimeException
$result = $db->execute();
} catch (RuntimeException $e) {
Factory::getApplication()->enqueueMessage($e->getMessage());
return false;
}
</source>
<translate> Add the extension configuration to the table (#__action_log_config) so that your actions data will be captured.</translate> 
<source lang="php">
$logConf = new stdClass();
$logConf->id = 0;
$logConf->type_title = 'transaction';
$logConf->type_alias = $extension;
$logConf->id_holder = 'id';
$logConf->title_holder = 'trans_desc';
$logConf->table_name = '#__mycomponent_transaction';
$logConf->text_prefix = 'COM_MYCOMPONENT_TRANSACTION';

try {
// If it fails, it will throw a RuntimeException
// Insert the object into the table.
$result = Factory::getDbo()->insertObject('#__action_log_config', $logConf);
} catch (RuntimeException $e) {
Factory::getApplication()->enqueueMessage($e->getMessage());
return false;
}
</source>
<translate> Of course it would be best to perform some checking to ensure that the record doesn't already exist.</translate>

<translate>

===Component Helper=== 
</translate>
<translate> In this example, the component helper is used to perform the storing of actions.</translate>

<source lang="php">
/**
* Record transaction details in log record
* @param object $user Saves getting the current user again.
* @param int $tran_id The transaction id just created or updated
* @param int $id Passed id reference from the form to identify if new record
* @return boolean True
*/
public static function recordActionLog($user = null, $tran_id = 0, $id = 0)
{
// get the component details such as the id
$extension = MycomponentHelper::getExtensionDetails('com_mycomponent');
// get the transaction details for use in the log for easy reference
$tran = MycomponentHelper::getTransaction($tran_id);
$con_type = "transaction";
if ($id === 0) { $type = 'New '; } else { $type = 'Update '; }

$message = array();
$message['action'] = $con_type;
$message['type'] = $type . $tran->tran_type . ' - '.$tran->tran_desc . ' $' . $tran->tran_amount;
$message['id'] = $tran->id;
$message['title'] = $extension->name;
$message['extension_name'] = $extension->name;
$message['itemlink'] = "index.php?option=com_mycomponent&task=transaction.edit&id=".$tran->id;
$message['userid'] = $user->id;
$message['username'] = $user->username;
$message['accountlink'] = "index.php?option=com_users&task=user.edit&id=".$user->id;

$messages = array($message);

$messageLanguageKey = Text::_('COM_MYCOMPONENT_TRANSACTION_LINK');
$context = $extension->name.'.'.$con_type;

$fmodel = MycomponentHelper::getForeignModel('Actionlog', 'ActionlogsModel');

$fmodel->addLog($messages, $messageLanguageKey, $context, $user->id);

return true;
}

/**
* Get the Model from another component for use
* @param string $name The model name. Optional. Default to my own for safety.
* @param string $prefix The class prefix. Optional
* @param array $config Configuration array for model. Optional
* @return object The model
*/
public function getForeignModel($name = 'Transaction', $prefix = 'MycomponentModel', $config = array('ignore_request' => true))
{
\Joomla\CMS\MVC\Model\ItemModel::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_actionlogs/models', 'ActionlogsModelActionlog');
$fmodel = \Joomla\CMS\MVC\Model\ItemModel::getInstance($name, $prefix, $config);

return $fmodel;
}

</source>

<translate>
===Front End Transaction Form=== 
</translate>
<translate> Now that the foundations are set, we just need to trigger the process. We're capturing information about a transaction that is created or update and we have a model called <tt>transactionform.php</tt>. It is in the Save method that we want to capture a log.</translate>

<source lang="php">
// So the code above this point checks and does what it should do and then after the successful save of the record, we check for the parameter setting to see if logging is required, we pass key elements to recordActionLog.
$table = $this->getTable();

if ($table->save($data) === true) {

/* ---------------------------------------------------------------- */
// trigger transaction log if required
$act_log = $params->get('act_log', 0);
if ($act_log && $table->id) {
// gather information and log in a new action log record
MycomponentHelper::recordActionLog($user, $table->id, $data['id']);
}
/* ---------------------------------------------------------------- */

return $table->id;
} else {
return false;
}
</source>

<translate>
===Language File=== 
</translate>
<translate> Finally, to help with the Action Log Listing in the admin side of Joomla, we want to set some key elements of data to be displayed in the language file en-GB.com_mycomponent.ini.</translate> 

<source lang="php">
<translate> COM_MYCOMPONENT_TRANSACTION_LINK="User <a href='{accountlink}'>{username}</a> created a transaction ( <a href='{itemlink}'>{type}</a> )"</translate>
</source>

<translate> Hope this helps.</translate>

<noinclude>
[[Category:Components{{#translation:}}]]
[[Category:Joomla! 3.9{{#translation:}}]]
[[Category:Plugins{{#translation:}}]]
[[Category:Modules{{#translation:}}]]
[[Category:User Action Logs{{#translation:}}]]
</noinclude>

SQL form field type

2019-08-28T10:55:08Z

ADaneInSpain: Added warning that an important feature of this field does not work.

<noinclude><languages /></noinclude>
{{Warning|<translate>
Using this generic form field type forces you to write SQL in an XML file and is rather limited. For more flexibility, consider creating your own, specific form field type by subclassing the JFormField class.</translate>}}

<translate>
The '''sql''' form field type provides a drop down list of entries obtained by running a query on the Joomla database. If the field has a value saved, this value is selected when the page is first loaded. If not, the default value (if any) is selected.</translate>
[[Image:Params.sql.jpg|right]]
<translate>
* '''type''' (mandatory) must be ''sql''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the field. This must match the name of the query results column that contains the values that will be shown to the user in the drop-down list, unless a different name is specified in the '''value_field''' attribute.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''query''' (mandatory if not using the sql_* attributes) is the SQL query which will provide the data for the drop-down list. The query must return two columns; one called ''<nowiki>'value'</nowiki>'' (unless overridden by the '''key_field''' attribute) which will hold the values of the list items; the other called the same as the value of the name attribute (unless overridden by the '''value_field''' attribute) containing the text to be shown in the drop-down list.</translate>
<translate>
* '''default''' (optional) is the default value. This is the value of the ''<nowiki>'value'</nowiki>'' column, unless overridden by the '''key_field''' attribute.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
* '''multiple''' (optional) turns the field into a multi-selector. Use multiple="multiple".
<translate>
* '''key_field''' (optional) is the name of the column that will contain values for the parameter. If omitted then the column called ''<nowiki>'value'</nowiki>'' will be used, if it exists.</translate>
<translate>
* '''value_field''' (optional) is the name of the column that will contain values to be shown to the user in the drop-down list. If omitted then the column with the same name as the name attribute will be used, if it exists.</translate>
<translate>
* '''translate''' (optional) will translate the output of the '''value_field''' if set to true. It defaults to false.</translate>
* '''header''' (optional) (translatable) will add an entry, with an empty value, at the top of the list of options. This is usually used to add a ''"- Select something -"'' entry to the list. See the examples for an alternative way of achieving this.
* '''sql_select''' (mandatory if not using the '''query''' attribute) is the SELECT clause of the SQL statement. Only one such clause is permitted.
* '''sql_from''' (mandatory if not using the '''query''' attribute) is the FROM clause of the SQL statement.
* '''sql_join''' (optional) is the LEFT JOIN clause of the SQL statement. Only one such clause is permitted.
* '''sql_where''' (optional) is the WHERE clause of the SQL statement. Only one such clause is permitted.
* '''sql_group''' (optional) is the GROUP BY clause of the SQL statement.
* '''sql_order''' (optional) is the ORDER BY clause of the SQL statement.
* '''sql_filter''' (optional) filters the list by the value of another field. A field name or a comma-separated list of field names can be given. The field names must correspond to column names in the database table being queried. See the examples for further explanation.
* '''sql_default_{FIELD_NAME}''' (optional) is the default value used by the '''sql_filter''' attribute when the value of the ''{FIELD_NAME}'' filter has not been set. See the examples for further explanation.

<translate>
Example XML parameter definition:</translate>
<source lang="xml">
<field
name="title"
type="sql"
default="10"
label="Select an article"
query="SELECT id AS value, title FROM #__content"
/>
</source>

<translate>
Notice that an AS clause has been used in this example because the ''jos_content'' table does not have a column called ''<nowiki>'value'</nowiki>''. In fact very few tables in the Joomla database have a column called ''<nowiki>'value'</nowiki>''.</translate>
<translate>
Alternatively, you can use a '''key_field''' attribute to define the column to be used instead of ''<nowiki>'value'</nowiki>'':</translate>
<source lang="xml">
<field
name="title"
type="sql"
default="10"
label="Select an article"
query="SELECT id, title FROM #__content"
key_field="id"
/>
</source>
<translate>
This will give identical results to the previous example.</translate>

<translate>
Both column names may need to be aliased. For example, suppose you want your field to be called ''<nowiki>'myfield'</nowiki>'' instead of ''<nowiki>'title'</nowiki>'' in the previous example. Then you can do this:</translate>
<source lang="xml">
<field
name="myfield"
type="sql"
default="10"
label="Select an article"
query="SELECT id AS value, title AS myfield FROM #__content"
/>
</source>
<translate>
Or alternatively:</translate>
<source lang="xml">
<field
name="myfield"
type="sql"
default="10"
label="Select an article"
query="SELECT id, title FROM #__content"
key_field="id"
value_field="title"
/>
</source>
<translate>
You can also assemble or calculate fields in the SQL statement. For example, suppose you wanted to append the created date/time of each article to the article title in the list. Then you could use this SQL statement:</translate>
<source lang="sql">
SELECT id, concat( title, ' (', created, ')') AS title FROM #__content
</source>
<translate>
You can also specify a static option in the XML using <option></option> tag. Please look at the following example.</translate>
<source lang="xml">
<field
name="myfield"
type="sql"
default="10"
label="Select an article"
query="SELECT id, title FROM #__content"
key_field="id"
value_field="title"
required="true"
>
<option value="">Please select your option</option>
</field>
</source>
Alternatively, you can achieve the same result using the '''header''' attribute as follows:
<source lang="xml">
<field
name="myfield"
type="sql"
default="10"
label="Select an article"
query="SELECT id, title FROM #__content"
key_field="id"
value_field="title"
required="true"
header="Please select your option"
/>
</source>
==== Alternative query syntax ====
Starting with Joomla 3.5, an alternative to the '''query''' attribute allows some additional features. These features are not available if the '''query''' attribute is present. For example, this field definition:
<source lang="xml">
<field
name="example_group"
type="sql"
label="COM_EXAMPLE_GROUP"
query="SELECT e.* FROM #__example AS e GROUP BY name ORDER e.id ASC"
key_field="id"
value_field="name"
/>
</source>
can be expressed as:
<source lang="xml">
<field
name="example_group"
type="sql"
label="COM_EXAMPLE_GROUP"
sql_select="e.*"
sql_from="#__example AS e"
sql_group="name"
sql_order="e.id ASC"
key_field="id"
value_field="name"
/>
</source>
{{warning|<translate>The following feature ''linked fields as filters'' is currently not working! See [https://github.com/joomla/joomla-cms/issues/22241 Github issue 22241]</translate>}}
One advantage to using this syntax is that it allows the use of linked fields as filters. For example, suppose you have a form containing two select lists, one called ''groups'' and the other called ''subgroups''. The ''groups'' field is straightforward:
<source lang="xml">
<field name="groups"
type="sql"
label="COM_EXAMPLE_GROUPS"
sql_select="e.*"
sql_from="#__example_groups AS e"
sql_group="name"
sql_order="e.id ASC"
key_field="id"
value_field="name"
/>
</source>
but the ''subgroups'' field includes an '''sql_filter''' attribute which refers to the ''groups'' field by name:
<source lang="xml">
<field name="subgroups"
type="sql"
label="COM_EXAMPLE_SUBGROUPS"
sql_select="e.*"
sql_from="#__example_subgroups AS e"
sql_group="name"
sql_order="e.id ASC"
sql_filter="groups"
key_field="id"
value_field="name"
/>
</source>
Then if the ''groups'' field has the value ''99'', the following SQL statement will be executed for the ''subgroups'' field:
<source lang="sql">
SELECT e.* FROM jos_example_subgroups AS e WHERE `groups` = 99 GROUP BY `name` ORDER BY e.id ASC
</source>
To filter on multiple fields, you can use a comma-separated list of filter names in the '''sql_filter''' clause. For example, if there is a filter called ''groups'' with the value ''99'' and a filter called ''categories'' with the value ''12'', then
<source lang="xml">
sql_filter="groups,categories"
</source>
will produce the SQL WHERE clause:
<source lang="sql">
WHERE `groups` = 99 AND `categories` = 12
</source>
You can also define a default value for any filter that might not have a value when the field is evaluated by adding '''sql_default_{FIELD_NAME}''' attributes. For example, suppose that the default value for the ''groups'' filter is 0 and the default value for the ''categories'' filter is 0, then this definition:
<source lang="xml">
<field name="subgroups"
type="sql"
label="COM_EXAMPLE_SUBGROUPS"
sql_select="e.*"
sql_from="#__example_subgroups AS e"
sql_group="name"
sql_order="e.id ASC"
sql_filter="groups,categories"
sql_default_groups="0"
sql_default_categories="1"
key_field="id"
value_field="name"
/>
</source>
will produce this SQL statement when initially evaluated with no filters:
<source lang="sql">
SELECT e.* FROM jos_example_subgroups AS e WHERE `groups` = 0 AND `categories` = 1 GROUP BY `name` ORDER BY e.id ASC
</source>
<translate>
Note: The SQL statements will need to be correct for the type and version of the underlying database that Joomla is running on. This will most likely be a version of MySQL, but it could be something else. There is no capability to query databases other than the one Joomla itself is running on.</translate>

<translate>
Note: As shown in these examples, the database prefix (often <code>jos</code>) should be entered in the form <code>#__</code> (hash-underscore-underscore). It will automatically be replaced by the actual database prefix used by Joomla.</translate>

<translate>
=== See also === 
</translate>
<translate>
* [[S:MyLanguage/Standard form field types|List of standard form field types]]</translate>
<noinclude><translate>
[[Category:Standard form field types]]</translate></noinclude>

User form field type

2019-04-29T09:03:15Z

ADaneInSpain: Added note that this field is not available in front end forms.

<noinclude><languages /></noinclude>
<translate>
The '''user''' form field type provides a modal select box of users.</translate>

<translate>
* '''type''' (mandatory) must be ''user''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the field. This must match the name of the query results column that contains the values that will be shown to the user in the drop-down list, unless a different name is specified in the ''value_field'' attribute</translate>.
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
<translate>
* '''class''' (optional) is a CSS class name for the HTML form field.</translate>
<translate>
* '''size''' (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.</translate>

<translate>
Implemented by:</translate> <tt>libraries/cms/form/field/user.php</tt>

<translate>
Example user form field definition:</translate>

<source type="php">
<field name="modified_user_id" type="user"
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
class="readonly"
readonly="true"
filter="unset" />
</source>

<translate>=== Note! ===</translate>
<translate>The '''user''' field only works on administration forms and should not be added to front-end forms.</translate>

<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Standard form field types|List of standard form field types]]</translate>

<noinclude>
<translate>

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

Editor form field type

2018-11-01T09:19:47Z

ADaneInSpain: Cols and rows also do not work

<noinclude><languages /></noinclude>
<translate>
The '''Editor''' field type provides a WYSIWYG editor.</translate>

<translate>
* '''type''' (mandatory) must be ''editor''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the parameter.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''width''' (optional) defines the width (in pixels) of the wysiwyg editor and defaults to 100%. '''(Currently not supported)'''</translate>
<translate>
* '''height''' (optional) defines the height (in pixels) of the wysiwyg editor and defaults to 250px. '''(Currently not supported)'''</translate>
<translate>
* '''cols''' (optional) defines the width of the editor (in columns). '''(Currently not supported)'''</translate>
<translate>
* '''rows''' (optional) defines the height of the editor (in rows). '''(Currently not supported)'''</translate>
<translate>
* '''buttons''' (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreak and readmore.</translate>
<translate>
* '''hide''' (optional) array of plugin buttons to be hidden. eg... set buttons="true" hide="readmore,pagebreak"</translate>
<translate>
* '''editor''' specifies the editor to be used and can include two options (editor="desired|alternative")</translate>
<translate>
* '''filter''' (optional) allow the system to save certain html tags or raw data.</translate>

<translate>
Example XML Definition:</translate>
<source lang="xml"><field name="test1" type="editor" label="Test Field" description="" width="300" filter="safehtml" /></source>

<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Textarea form field type|Textarea form field type]]</translate>
<translate>
* [[S:MyLanguage/Standard form field types|Table of all standard form field types]]</translate>

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

Editor form field type

2018-10-31T09:32:11Z

ADaneInSpain: Marked some attributes as not supported because they aren't

<noinclude><languages /></noinclude>
<translate>
The '''Editor''' field type provides a WYSIWYG editor.</translate>

<translate>
* '''type''' (mandatory) must be ''editor''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the parameter.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''width''' (optional) defines the width (in pixels) of the wysiwyg editor and defaults to 100%. '''(Currently not supported)'''</translate>
<translate>
* '''height''' (optional) defines the height (in pixels) of the wysiwyg editor and defaults to 250px. '''(Currently not supported)'''</translate>
<translate>
* '''cols''' (optional) defines the width of the editor (in columns).</translate>
<translate>
* '''rows''' (optional) defines the height of the editor (in rows).</translate>
<translate>
* '''buttons''' (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreak and readmore.</translate>
<translate>
* '''hide''' (optional) array of plugin buttons to be hidden. eg... set buttons="true" hide="readmore,pagebreak"</translate>
<translate>
* '''editor''' specifies the editor to be used and can include two options (editor="desired|alternative")</translate>
<translate>
* '''filter''' (optional) allow the system to save certain html tags or raw data.</translate>

<translate>
Example XML Definition:</translate>
<source lang="xml"><field name="test1" type="editor" label="Test Field" description="" width="300" filter="safehtml" /></source>

<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Textarea form field type|Textarea form field type]]</translate>
<translate>
* [[S:MyLanguage/Standard form field types|Table of all standard form field types]]</translate>

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

Checkbox form field type

2018-10-11T13:05:37Z

ADaneInSpain: Removed references to "default" as it is not relevant on a checkbox and added the attribute "checked" which was missing

<noinclude><languages /></noinclude>
<translate>
The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.</translate>

<translate>
* '''type''' (mandatory) must be checkbox</translate>
* '''name''' (mandatory) is the unique name of the parameter.
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''value''' (optional) is the value of the parameter if this checkbox is set (usually 1).</translate>
<translate>
* '''checked''' (optional) should be set to 1 to check the checkbox by default or 0 not to.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the label.</translate>
<translate>
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.</translate>

<translate>
Example XML field definition:</translate>
<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" /></source>

<translate>
Example XML field definition (checked):</translate>

<source lang="xml"><field name="show_title" type="checkbox" label="Show title" description="Show the title of the item" value="1" checked="1" /></source>

{{warning|<translate>
Special care needs to be taken with saving a checkbox from a form!! This is a common mistake. You see, on saving a form with a checkbox that is unchecked, there is no variable for it in the POST information and joomla does not take care of that yet! See Discussion on [[Talk:Checkbox form field type|this page]] for more.</translate>}}
<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Standard form field types|List of standard form field types]]</translate>

<noinclude>
<translate>

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

GSOC 2014 Project Ideas

2014-02-04T16:15:26Z

ADaneInSpain: Added Buddhima

[[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: Create a baseline component based on the Unified Content Model ===

:'''Brief explanation:''' The Joomla! CMS has been moving towards a unified content model for which to serve content from. Presently, a separate component is required for all content types (articles, categories, and weblinks, for example). In the unified content model, all content types share a similar base dataset and components can add support for custom fields using the current component model of adding separate database tables.

:'''Expected Results:''' The goal for this project is to build a Joomla! CMS component which is based on the unified content model. A practical example of this would be a new component to manage articles which would be a replacement for the existing com_content component.

:'''Knowledge Prerequisite:'''

:'''Difficulty:'''

=== Project: Decouple extension dependencies ===

:'''Brief explanation:''' 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.

:'''Expected Results:''' All extensions in the CMS to be completely independent of one another.

:'''Knowledge Prerequisite:'''

:'''Difficulty:''' Medium

=== 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 increase site performance, 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

:'''Posible mentors:''' Nicola Galgano




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

== 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

[[Category:Google Summer of Code 2014]]

GSOC 2014 Project Ideas

2014-02-04T15:16:00Z

ADaneInSpain: /* Project: Update Core Extensions to use New MVC */

[[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: Create a baseline component based on the Unified Content Model ===

:'''Brief explanation:''' The Joomla! CMS has been moving towards a unified content model for which to serve content from. Presently, a separate component is required for all content types (articles, categories, and weblinks, for example). In the unified content model, all content types share a similar base dataset and components can add support for custom fields using the current component model of adding separate database tables.

:'''Expected Results:''' The goal for this project is to build a Joomla! CMS component which is based on the unified content model. A practical example of this would be a new component to manage articles which would be a replacement for the existing com_content component.

:'''Knowledge Prerequisite:'''

:'''Difficulty:'''

=== Project: Decouple extension dependencies ===

:'''Brief explanation:''' 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.

:'''Expected Results:''' All extensions in the CMS to be completely independent of one another.

:'''Knowledge Prerequisite:'''

:'''Difficulty:''' Medium

=== 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

===Project: SQL Optimization===

:'''Brief explanation:''' The goal of this project is to increase site performance, 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

:'''Posible mentors:''' Nicola Galgano




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

== 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

[[Category:Google Summer of Code 2014]]

GSOC 2014 Project Ideas

2014-02-04T15:14:47Z

ADaneInSpain: /* Project: Develop dependency manager */

[[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: Create a baseline component based on the Unified Content Model ===

:'''Brief explanation:''' The Joomla! CMS has been moving towards a unified content model for which to serve content from. Presently, a separate component is required for all content types (articles, categories, and weblinks, for example). In the unified content model, all content types share a similar base dataset and components can add support for custom fields using the current component model of adding separate database tables.

:'''Expected Results:''' The goal for this project is to build a Joomla! CMS component which is based on the unified content model. A practical example of this would be a new component to manage articles which would be a replacement for the existing com_content component.

:'''Knowledge Prerequisite:'''

:'''Difficulty:'''

=== Project: Decouple extension dependencies ===

:'''Brief explanation:''' 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.

:'''Expected Results:''' All extensions in the CMS to be completely independent of one another.

:'''Knowledge Prerequisite:'''

:'''Difficulty:''' Medium

=== 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 Component-Creator.com

===Project: SQL Optimization===

:'''Brief explanation:''' The goal of this project is to increase site performance, 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

:'''Posible mentors:''' Nicola Galgano




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

== 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

[[Category:Google Summer of Code 2014]]

GSOC 2014 Project Ideas

2014-02-04T15:14:05Z

ADaneInSpain: Added Soren as potential mento

[[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: Create a baseline component based on the Unified Content Model ===

:'''Brief explanation:''' The Joomla! CMS has been moving towards a unified content model for which to serve content from. Presently, a separate component is required for all content types (articles, categories, and weblinks, for example). In the unified content model, all content types share a similar base dataset and components can add support for custom fields using the current component model of adding separate database tables.

:'''Expected Results:''' The goal for this project is to build a Joomla! CMS component which is based on the unified content model. A practical example of this would be a new component to manage articles which would be a replacement for the existing com_content component.

:'''Knowledge Prerequisite:'''

:'''Difficulty:'''

=== Project: Decouple extension dependencies ===

:'''Brief explanation:''' 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.

:'''Expected Results:''' All extensions in the CMS to be completely independent of one another.

:'''Knowledge Prerequisite:'''

:'''Difficulty:''' Medium

=== 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 Component-Creator.com

===Project: SQL Optimization===

:'''Brief explanation:''' The goal of this project is to increase site performance, 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

:'''Posible mentors:''' Nicola Galgano




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

== 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

[[Category:Google Summer of Code 2014]]