Joomla! Documentation - User contributions [en]

J4.x:Joomla Entities

2018-08-12T17:22:12Z

Isac: /* Filtering */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 <br />
Joomla Entities<br />Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==

The scope of this year project is to build and integrate a new Model system into Joomla 4, that will solve some of the current issues from the Webservices project, as well as improve the limits of the current system. The integration will be fully implemented by the release of Joomla 4.0 in the com_content component. The purpose for this documentation is to outline how to use the underlaying Entities project, which can be then used by developers to write new extensions and convert existing ones.

Entities! The entities project is the base project. Without it we would not be able to accomplish the tasks in the Webservices project. Starting as a new project, I have managed to get a basic implementation going of an Active Record pattern based layer that shall be used as a dependency in Joomla CMS, to implement each table as a DAO.

The need for this project comes from the limitations of the current Model architecture which have been reached during the last year GSoC Webservices [https://joomla-projects.github.io/gsoc18_webservices/?specification/introduction.md project].

Because by reaching these limitations, it was clear that the Model layer had to be redone. Taking it a step further, with the desire to make development in Joomla easier, the Entities [https://github.com/joomla-projects/entities project] was born. The main highlights of this approach is that we can now have relations in our models, feature that has been long missed in Joomla models. Up to now, the One to One and One To Many relations have been implemented.

The project fits perfectly in the Joomla ecosystem, as it is using the joomla-framework/database DatabaseDriver for the connection to various database systems. We have decided that the next step would be actually integrating the Entities project in Joomla CMS, in the lib_api branch of the last year webservices project. Taking a step back from implementing features in a separate project, and actually connecting the dots with the CMS implementation will give us important insights about the features that will be needed in the future.

== Installation ==

The entities project can be easily integrated into any php project by adding the following dependency to your composer file:

<source lang="php">
"config": {
"preferred-install": {
"joomla/event": "dist"
},
"require": {
"joomla/entities": "dev-master"
}
}
</source>

== Usage ==

=== Defining Entities ===

* Table - The table name should have '#__' as a prefix. The Entity also sets a default table name in case none is specified by the developer. The default value is the pluralised and underscore separated Class name.

<source lang="php">
/**
* The table associated with the model.
*
* @var string
*/
protected $table = '#__content';</source>

* Timestamps - specify is the current entity uses timestamps or not. If it does, special column aliases need to be specified for the 'createdAt' and 'updatedAt' columns. These two columns are handled automatically by the project when creating or updating the entity.

<source lang="php">
/**
* Indicates if the model should be timestamped.
*
* @var boolean
*/
public $timestamps = false;</source>

* Column Aliases - having the same functionality as in the current Joomla implementation, they provide a way to be able to refer at different column names across different components with one name in case they fulfil the same functionality.

<source lang="php">
/**
* Array with alias for "special" columns such as ordering, hits etc etc
*
* @var array
*/
protected $columnAlias = [
'createdAt' => 'created',
'updatedAt' => 'modified',
'published' => 'state'
];</source>

* Casts - Used to cast database raw strings into usable types in PHP. Two most common use cases are 'int' and 'array'. The latter is specifically useful as it transforms json columns into key indexed arrays.

<source lang="php">
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'params' => 'array'
];</source>

* Dates - used to cast dates to Carbon instances

<source lang="php">
/**
* The attributes that should be mutated to dates. Already aliased!
*
* @var array
*/
protected $dates = [
'registerDate',
'lastvisitDate',
'lastResetTime'
];</source>

* Hidden - used to hide certain columns from serialisation. E.g. passwords.

<source lang="php">
/**
* The attributes that should be hidden for serialization.
*
* @var array
*/
protected $hidden = [
'password'
];</source>

* With - eager load relations into the entity. If not specified, the relations are lazy loaded. The primary key and foreign key are mandatory if the relation is loaded with constraints(selecting only some of the columns for efficiency purposes)

<source lang="php">
/**
* The relations to eager load on every query.
*
* @var array
* @todo add to docs:
*/
protected $with = array(
'sentMessages:message_id,subject,user_id_from'
);</source>

=== Defining Entities Relations ===

* HasOne - One to One relation.

Signature:
<source lang="php">
/**
* Define a one-to-one relation.
*
* @param string $related related Model
* @param string $foreignKey foreign key name in current mode
* @param string $localKey local primary key name
* @return \Joomla\Entity\Relations\HasOne
*/
public function hasOne($related, $foreignKey = null, $localKey = null)</source>

Example:
<source lang="php">
/**
* Get the profile for the current user.
* @return Relation
*/
public function profile()
{
return $this->hasOne('Joomla\Entity\Tests\Models\UserProfile');
}</source>

* HasMany - One to Many relation.

Signature:
<source lang="php">
/**
* Define a one-to-many relation.
*
* @param string $related related Model
* @param string $foreignKey foreign key name in current mode
* @param string $localKey local primary key name
* @return \Joomla\Entity\Relations\HasMany
*/
public function hasMany($related, $foreignKey = null, $localKey = null)</source>

Example:
<source lang="php">
/**
* Get the sent messages for the current user.
* @return Relation
*/
public function sentMessages()
{
return $this->hasMany('Joomla\Entity\Tests\Models\Message', 'user_id_from');
}
</source>

* BelongsTo - Reverse relation for One to One or One to Many.

Signature:
<source lang="php">
/**
* Define an inverse one-to-one or many relation.
*
* @param string $related related Model
* @param string $relation relation name, must be the same as the caller function
* @param string $foreignKey foreign key name in current mode
* @param string $ownerKey the associated key on the parent model.
* @return \Joomla\Entity\Relations\BelongsTo
*/
public function belongsTo($related, $relation, $foreignKey = null, $ownerKey = null)</source>

Example:
<source lang="php">
/**
* Get the author for the current article.
*
* @return Relation
*/
public function author()
{
return $this->belongsTo('Joomla\CMS\Entity\User', 'author', 'created_by');
}</source>

=== Queries Using The Entity ===
The following default functionalities are available for the entities:

* Find - finds an entity or a Collection of entities by their primary keys. In addition, the columns that are desired to be loaded can be specified. By default, we load all the columns.

Signature:
<source lang="php">
/**
* Find a model by its primary key.
*
* @param mixed $id primary key
* @param array $columns columns to be selected in query
*
* @return Model|boolean
*/
public function find($id, $columns = ['*'])
</source>

* Insert - This is the way to insert a new row in a table. First we create a new entity using the desired attribute, next we persist it to the database.

Example:
<source lang="php">
$attributes = [
'email' => "test@test.com",
'params' => ['test' => 'val']
];

$user = new User(self::$driver, $attributes);

$user->persist();</source>

* Update - This is the way to update an existing entity. Entities attributes can be accessed as normal class properties using magic methods.

Example:
<source lang="php">
$model = new User(self::$driver);

$user = $model->find(100);
$user->resetCount = 10;

$user->update();</source>

* Delete - This is a way to delete a row from the table using it's primary key.

Example:
<source lang="php">
$model = new User(self::$driver);

$user = $model->find(100);
$user->resetCount = 10;

$user->update();</source>

* Get - The get method returns all the models that are in the table, respectively, all the filters that have been applied to the entity so far. Please check the list of filter methods at the end of this section for more details.

Signature:
<source lang="php">
/**
* Finds all the Models with eager relations loaded
*
* @param array $columns columns to be selected in query
* @return Collection
*/
public function get($columns = ['*'])</source>

* Count - The count method counts the all the rows from the table, respectively all the rows that satisfy filters that have been applied to the entity so far.

Example:
<source lang="php">
$model = new User(self::$driver);
$count = $model->count();</source>

==== Filtering ====

* select - selects only the specified columns in the next query.

<source lang="php">
/* @method select() select(array $columns) */
</source>

* where -> adds a where clause in the next query that will be executed.

<source lang="php">
/* @method where() where($conditions, string $glue = 'AND') */
</source>

* orders -> adds an ORDER BY clause to the next query.

<source lang="php">
/* @method order() order($columns) */
</source>

* filter - applies a custom filter on a relation. This is the Entities way of making joins.

<source lang="php">
/* @method filter() filter(string $relation, Closure $callback) */

// The following query only counts users which sent a message with subject "sentMessages".
$model = new User(self::$driver);
$model->filter('sentMessages',
function ($query)
{
$query->where("subject = 'message1'");
}
);
$count = $model->count();
</source>
<noinclude>
[[Category:Google Summer of Code 2018{{#translation:}}]]
[[Category:Development{{#translation:}}]]
[[Category:Joomla!_4.x{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
</noinclude>

J4.x:Joomla Entities

2018-08-12T17:12:23Z

Isac: /* Using the Entity */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 <br />
Joomla Entities<br />Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==

The scope of this year project is to build and integrate a new Model system into Joomla 4, that will solve some of the current issues from the Webservices project, as well as improve the limits of the current system. The integration will be fully implemented by the release of Joomla 4.0 in the com_content component. The purpose for this documentation is to outline how to use the underlaying Entities project, which can be then used by developers to write new extensions and convert existing ones.

Entities! The entities project is the base project. Without it we would not be able to accomplish the tasks in the Webservices project. Starting as a new project, I have managed to get a basic implementation going of an Active Record pattern based layer that shall be used as a dependency in Joomla CMS, to implement each table as a DAO.

The need for this project comes from the limitations of the current Model architecture which have been reached during the last year GSoC Webservices [https://joomla-projects.github.io/gsoc18_webservices/?specification/introduction.md project].

Because by reaching these limitations, it was clear that the Model layer had to be redone. Taking it a step further, with the desire to make development in Joomla easier, the Entities [https://github.com/joomla-projects/entities project] was born. The main highlights of this approach is that we can now have relations in our models, feature that has been long missed in Joomla models. Up to now, the One to One and One To Many relations have been implemented.

The project fits perfectly in the Joomla ecosystem, as it is using the joomla-framework/database DatabaseDriver for the connection to various database systems. We have decided that the next step would be actually integrating the Entities project in Joomla CMS, in the lib_api branch of the last year webservices project. Taking a step back from implementing features in a separate project, and actually connecting the dots with the CMS implementation will give us important insights about the features that will be needed in the future.

== Installation ==

The entities project can be easily integrated into any php project by adding the following dependency to your composer file:

<source lang="php">
"config": {
"preferred-install": {
"joomla/event": "dist"
},
"require": {
"joomla/entities": "dev-master"
}
}
</source>

== Usage ==

=== Defining Entities ===

* Table - The table name should have '#__' as a prefix. The Entity also sets a default table name in case none is specified by the developer. The default value is the pluralised and underscore separated Class name.

<source lang="php">
/**
* The table associated with the model.
*
* @var string
*/
protected $table = '#__content';</source>

* Timestamps - specify is the current entity uses timestamps or not. If it does, special column aliases need to be specified for the 'createdAt' and 'updatedAt' columns. These two columns are handled automatically by the project when creating or updating the entity.

<source lang="php">
/**
* Indicates if the model should be timestamped.
*
* @var boolean
*/
public $timestamps = false;</source>

* Column Aliases - having the same functionality as in the current Joomla implementation, they provide a way to be able to refer at different column names across different components with one name in case they fulfil the same functionality.

<source lang="php">
/**
* Array with alias for "special" columns such as ordering, hits etc etc
*
* @var array
*/
protected $columnAlias = [
'createdAt' => 'created',
'updatedAt' => 'modified',
'published' => 'state'
];</source>

* Casts - Used to cast database raw strings into usable types in PHP. Two most common use cases are 'int' and 'array'. The latter is specifically useful as it transforms json columns into key indexed arrays.

<source lang="php">
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'params' => 'array'
];</source>

* Dates - used to cast dates to Carbon instances

<source lang="php">
/**
* The attributes that should be mutated to dates. Already aliased!
*
* @var array
*/
protected $dates = [
'registerDate',
'lastvisitDate',
'lastResetTime'
];</source>

* Hidden - used to hide certain columns from serialisation. E.g. passwords.

<source lang="php">
/**
* The attributes that should be hidden for serialization.
*
* @var array
*/
protected $hidden = [
'password'
];</source>

* With - eager load relations into the entity. If not specified, the relations are lazy loaded. The primary key and foreign key are mandatory if the relation is loaded with constraints(selecting only some of the columns for efficiency purposes)

<source lang="php">
/**
* The relations to eager load on every query.
*
* @var array
* @todo add to docs:
*/
protected $with = array(
'sentMessages:message_id,subject,user_id_from'
);</source>

=== Defining Entities Relations ===

* HasOne - One to One relation.

Signature:
<source lang="php">
/**
* Define a one-to-one relation.
*
* @param string $related related Model
* @param string $foreignKey foreign key name in current mode
* @param string $localKey local primary key name
* @return \Joomla\Entity\Relations\HasOne
*/
public function hasOne($related, $foreignKey = null, $localKey = null)</source>

Example:
<source lang="php">
/**
* Get the profile for the current user.
* @return Relation
*/
public function profile()
{
return $this->hasOne('Joomla\Entity\Tests\Models\UserProfile');
}</source>

* HasMany - One to Many relation.

Signature:
<source lang="php">
/**
* Define a one-to-many relation.
*
* @param string $related related Model
* @param string $foreignKey foreign key name in current mode
* @param string $localKey local primary key name
* @return \Joomla\Entity\Relations\HasMany
*/
public function hasMany($related, $foreignKey = null, $localKey = null)</source>

Example:
<source lang="php">
/**
* Get the sent messages for the current user.
* @return Relation
*/
public function sentMessages()
{
return $this->hasMany('Joomla\Entity\Tests\Models\Message', 'user_id_from');
}
</source>

* BelongsTo - Reverse relation for One to One or One to Many.

Signature:
<source lang="php">
/**
* Define an inverse one-to-one or many relation.
*
* @param string $related related Model
* @param string $relation relation name, must be the same as the caller function
* @param string $foreignKey foreign key name in current mode
* @param string $ownerKey the associated key on the parent model.
* @return \Joomla\Entity\Relations\BelongsTo
*/
public function belongsTo($related, $relation, $foreignKey = null, $ownerKey = null)</source>

Example:
<source lang="php">
/**
* Get the author for the current article.
*
* @return Relation
*/
public function author()
{
return $this->belongsTo('Joomla\CMS\Entity\User', 'author', 'created_by');
}</source>

=== Queries Using The Entity ===
The following default functionalities are available for the entities:

* Find - finds an entity or a Collection of entities by their primary keys. In addition, the columns that are desired to be loaded can be specified. By default, we load all the columns.

Signature:
<source lang="php">
/**
* Find a model by its primary key.
*
* @param mixed $id primary key
* @param array $columns columns to be selected in query
*
* @return Model|boolean
*/
public function find($id, $columns = ['*'])
</source>

* Insert - This is the way to insert a new row in a table. First we create a new entity using the desired attribute, next we persist it to the database.

Example:
<source lang="php">
$attributes = [
'email' => "test@test.com",
'params' => ['test' => 'val']
];

$user = new User(self::$driver, $attributes);

$user->persist();</source>

* Update - This is the way to update an existing entity. Entities attributes can be accessed as normal class properties using magic methods.

Example:
<source lang="php">
$model = new User(self::$driver);

$user = $model->find(100);
$user->resetCount = 10;

$user->update();</source>

* Delete - This is a way to delete a row from the table using it's primary key.

Example:
<source lang="php">
$model = new User(self::$driver);

$user = $model->find(100);
$user->resetCount = 10;

$user->update();</source>

* Get - The get method returns all the models that are in the table, respectively, all the filters that have been applied to the entity so far. Please check the list of filter methods at the end of this section for more details.

Signature:
<source lang="php">
/**
* Finds all the Models with eager relations loaded
*
* @param array $columns columns to be selected in query
* @return Collection
*/
public function get($columns = ['*'])</source>

* Count - The count method counts the all the rows from the table, respectively all the rows that satisfy filters that have been applied to the entity so far.

Example:
<source lang="php">
$model = new User(self::$driver);
$count = $model->count();</source>

==== Filtering ====

<noinclude>
[[Category:Google Summer of Code 2018{{#translation:}}]]
[[Category:Development{{#translation:}}]]
[[Category:Joomla!_4.x{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
</noinclude>

J4.x:Joomla Entities

2018-08-12T14:06:59Z

Isac: /* Usage */

{{Top portal heading|color=white-bkgd|text-color=#333|title=
GSoC 2018 <br />
Joomla Entities<br />Documentation}}
[[Image:Gsoc2016.png|75px|center|link=GSOC 2018]]
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{-}}

== Introduction ==

The scope of this year project is to build and integrate a new Model system into Joomla 4, that will solve some of the current issues from the Webservices project, as well as improve the limits of the current system. The integration will be fully implemented by the release of Joomla 4.0 in the com_content component. The purpose for this documentation is to outline how to use the underlaying Entities project, which can be then used by developers to write new extensions and convert existing ones.

Entities! The entities project is the base project. Without it we would not be able to accomplish the tasks in the Webservices project. Starting as a new project, I have managed to get a basic implementation going of an Active Record pattern based layer that shall be used as a dependency in Joomla CMS, to implement each table as a DAO.

The need for this project comes from the limitations of the current Model architecture which have been reached during the last year GSoC Webservices [https://joomla-projects.github.io/gsoc18_webservices/?specification/introduction.md project].

Because by reaching these limitations, it was clear that the Model layer had to be redone. Taking it a step further, with the desire to make development in Joomla easier, the Entities [https://github.com/joomla-projects/entities project] was born. The main highlights of this approach is that we can now have relations in our models, feature that has been long missed in Joomla models. Up to now, the One to One and One To Many relations have been implemented.

The project fits perfectly in the Joomla ecosystem, as it is using the joomla-framework/database DatabaseDriver for the connection to various database systems. We have decided that the next step would be actually integrating the Entities project in Joomla CMS, in the lib_api branch of the last year webservices project. Taking a step back from implementing features in a separate project, and actually connecting the dots with the CMS implementation will give us important insights about the features that will be needed in the future.

== Installation ==

The entities project can be easily integrated into any php project by adding the following dependency to your composer file:

<source lang="php">
"config": {
"preferred-install": {
"joomla/event": "dist"
},
"require": {
"joomla/entities": "dev-master"
}
}
</source>

== Usage ==

=== Defining Entities ===

* Table - The table name should have '#__' as a prefix. The Entity also sets a default table name in case none is specified by the developer. The default value is the pluralised and underscore separated Class name.

<source lang="php">
/**
* The table associated with the model.
*
* @var string
*/
protected $table = '#__content';</source>

* Timestamps - specify is the current entity uses timestamps or not. If it does, special column aliases need to be specified for the 'createdAt' and 'updatedAt' columns. These two columns are handled automatically by the project when creating or updating the entity.

<source lang="php">
/**
* Indicates if the model should be timestamped.
*
* @var boolean
*/
public $timestamps = false;</source>

* Column Aliases - having the same functionality as in the current Joomla implementation, they provide a way to be able to refer at different column names across different components with one name in case they fulfil the same functionality.

<source lang="php">
/**
* Array with alias for "special" columns such as ordering, hits etc etc
*
* @var array
*/
protected $columnAlias = [
'createdAt' => 'created',
'updatedAt' => 'modified',
'published' => 'state'
];</source>

* Casts - Used to cast database raw strings into usable types in PHP. Two most common use cases are 'int' and 'array'. The latter is specifically useful as it transforms json columns into key indexed arrays.

<source lang="php">
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [
'params' => 'array'
];</source>

* Dates - used to cast dates to Carbon instances

<source lang="php">
/**
* The attributes that should be mutated to dates. Already aliased!
*
* @var array
*/
protected $dates = [
'registerDate',
'lastvisitDate',
'lastResetTime'
];</source>

* Hidden - used to hide certain columns from serialisation. E.g. passwords.

<source lang="php">
/**
* The attributes that should be hidden for serialization.
*
* @var array
*/
protected $hidden = [
'password'
];</source>

* With - eager load relations into the entity. If not specified, the relations are lazy loaded. The primary key and foreign key are mandatory if the relation is loaded with constraints(selecting only some of the columns for efficiency purposes)

<source lang="php">
/**
* The relations to eager load on every query.
*
* @var array
* @todo add to docs:
*/
protected $with = array(
'sentMessages:message_id,subject,user_id_from'
);</source>

=== Defining Entities Relations ===

* HasOne - One to One relation.

Signature:
<source lang="php">
/**
* Define a one-to-one relation.
*
* @param string $related related Model
* @param string $foreignKey foreign key name in current mode
* @param string $localKey local primary key name
* @return \Joomla\Entity\Relations\HasOne
*/
public function hasOne($related, $foreignKey = null, $localKey = null)</source>

Example:
<source lang="php">
/**
* Get the profile for the current user.
* @return Relation
*/
public function profile()
{
return $this->hasOne('Joomla\Entity\Tests\Models\UserProfile');
}</source>

* HasMany - One to Many relation.

Signature:
<source lang="php">
/**
* Define a one-to-many relation.
*
* @param string $related related Model
* @param string $foreignKey foreign key name in current mode
* @param string $localKey local primary key name
* @return \Joomla\Entity\Relations\HasMany
*/
public function hasMany($related, $foreignKey = null, $localKey = null)</source>

Example:
<source lang="php">
/**
* Get the sent messages for the current user.
* @return Relation
*/
public function sentMessages()
{
return $this->hasMany('Joomla\Entity\Tests\Models\Message', 'user_id_from');
}
</source>

* BelongsTo - Reverse relation for One to One or One to Many.

Signature:
<source lang="php">
/**
* Define an inverse one-to-one or many relation.
*
* @param string $related related Model
* @param string $relation relation name, must be the same as the caller function
* @param string $foreignKey foreign key name in current mode
* @param string $ownerKey the associated key on the parent model.
* @return \Joomla\Entity\Relations\BelongsTo
*/
public function belongsTo($related, $relation, $foreignKey = null, $ownerKey = null)</source>

Example:
<source lang="php">
/**
* Get the author for the current article.
*
* @return Relation
*/
public function author()
{
return $this->belongsTo('Joomla\CMS\Entity\User', 'author', 'created_by');
}</source>

=== Using the Entity ===

<noinclude>
[[Category:Google Summer of Code 2018{{#translation:}}]]
[[Category:Development{{#translation:}}]]
[[Category:Joomla!_4.x{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
</noinclude>

J4.x:Joomla Entities

2018-08-12T13:03:08Z

Isac: /* Installation */

J4.x:Joomla Entities

2018-08-12T13:00:25Z

Isac: Joomla Entities Documentation

User:Isac

2018-08-10T12:58:17Z

Isac:

This is my page for GSOC 2017 & 2018.

File:Overall diagram.png

2017-08-24T18:43:12Z

Isac:

Parallel Testing Project Overall Diagram

User:Isac

2017-08-24T14:38:20Z

Isac: Created page with "This is my page for GSOC 2017."

This is my page for GSOC 2017.

File:Codeception Logs.png

2017-08-24T08:17:48Z

Isac:

Codeception Logs Format

JDOC:Documentation Translators

2017-04-06T13:29:42Z

Isac: /* ro - Română - Romanian */

[[File:JDOC translation icon.png|right]]
Here, people '''translating''' {{SITENAME}} can sign up as a translator. Please be sure to read the required reading list below.

After you add your username to the list below under the appropriate language heading, a [[JDOC:Translation Administrators|Translation Administrator]] will assign your username translator permissions. After your username is added as a translator you can start translating! Please be on the look out for a [[Template:Translator welcome|welcome messaFvertaage]] with more information posted to your user talk page.{{-}}

== Required Reading ==
* Getting started, read [[JDOC:Page Translation Quickstart Guide|Page Translation Quickstart Guide]]
* Detailed explanation of translating, [[JDOC:Page Translation Explained|Page Translation Explained]].
* Our [[JDOC:Language policy|Language policy]]
* [[JDOC:Translator Tips|Translator Tips]]
* [[Joomla:JDOC%27s_Translation_Guidelines|Translation Guidelines]]
* Having an [[JDOC:Translation Questions|issue or need help]]?

{{tip|text=Dear translators! Please [[Special:TranslatorSignup|register for translator notifications about your language]]. You are placed on a list to receive notices about new/updated pages that need translation.|title=A Tip for Translators}}

===Add Your Language===
If your language isn't listed below, please add it using the format:

<code><lang code> - Localised language name - English language name </code>

Use the syntax, <code><nowiki>* {{User|YourUsername}}</nowiki> - requested</code>

When a Translation Administrator adds you as a translator, they will remove the "- requested" from your username.

==Current Translations Teams==

Documentation language codes are different from Joomla! language codes, they are ISO 639-1 2 letter code. A small quantity of 4 letter language codes are used as an exception, but these language codes are all lowercase.

=== ar - عربي - arabe ===
* {{User|ghilo}}
* {{User|HawraMilani}}
* {{User|hossen}}

=== af - Afrikaans ===
*{{User|JoeSA}}

=== bg - Български - Bulgarian ===
* {{User|bdimov}}
* {{User|Mastwd}}

=== ca - Català - Catalan ===
* {{User|el_libre}}

=== cs - Čeština - Czech ===
* {{User|fredericco-cz}}

=== da - Dansk - Danish ===
* {{User|ot2sen}}
* {{User|rbuelund}}

=== de - Deutsch - German ===
* {{User|Astridx}}
* {{User|Assmann}}
* {{User|Balzercomp}}
* {{User|ceus1984}}
* {{User|Chmst}}
* {{User|chrishoefliger}}
* {{User|FrankyD}}
* {{User|fruppel}}
* {{User|gorgonz}}
* {{User|jehacgn}}
* {{User|joomla-agency}}
* {{User|Ka3media}}
* {{User|King_Louis_1}}
* {{User|Kolvar}}
* {{User|Kurztipp}}
* {{User|m-b-o}}
* {{User|michaelmyk}}
* {{User|Paterna}}
* {{User|Pete71}}
* {{User|phillopp}}
* {{User|plocher}}
* {{User|Prof.Logout}}
* {{User|SeigetsuShoen}}
* {{User|Sisko1990}}
* {{User|Stefanie}}
* {{User|Tkahl}}
* {{User|UCFnet002}}
* {{User|Usimon}}
* {{User|Webberry}}
* {{User|Yvesh}}
* {{User|zero24}}

=== el - Ελληνικά - Greek ===
* {{User|pnkr}}

=== es - Español - Spanish ===
* {{User|Abulafia}}
* {{User|BNovoa.S}}
* {{User|carcam}}
* {{User|cristobal.vio}}
* {{User|Crsanchez}}
* {{User|danielperaza}}
* {{User|framon}}
* {{User|Irene.lopez}}
* {{User|isidrobaq}}
* {{User|ivanramosnet}}
* {{User|Javiparati}}
* {{User|Jcollver}}
* {{User|Leo_Soto}}
* {{User|netandsoftware}}
* {{User|NunoLopes}}
* {{User|pfvidal}}
* {{User|shaz}}
* {{User|Urielmx}}
* {{User|VictorYork87}}
* {{User|viena}}
* {{User|Willin}}

=== et - Eesti - Estonian ===
* {{User|Eraser}}

=== fa - فارسی - Persian ===
* {{User|Grand}}
* {{User|Heydari}}
* {{User|Levelup}}
* {{User|mhehm}}

=== fr - Français - French ===
* {{User|edelouche}}
* {{User|MATsxm}}
* {{User|Opware2000}}
* {{User|Perete}}
* {{User|Sandra97}}
* {{User|david613}}

=== ga - Gaeilge - Irish ===
* {{User|rvbgnu}}

=== he - עברית - Hebrew ===
* {{User|ydl}}
* {{User|shirdesign}}

=== hi - हिंदी - Hindi ===
* {{User|Rana}}
* {{User|Syhussaini}}
* {{User|Shivamrajput}}

=== hu - Magyar - Hungarian ===
* {{User|Balazs}}
* {{User|webgobe}}

=== hy - Հայերեն - Armenian ===
* {{User|Aaleksanyants}}

=== id - Bahasa Indonesia - Indonesian ===
* {{User|dw1Rianto}}
* {{User|Micokelana}}
* {{User|sikumbang}}

=== it - Italiano - Italian ===
* {{User|alexred}}
* {{User|alikon}}
* {{User|CinziaDesign}}
* {{User|donato}}
* {{User|Luca.marzo}}
* {{User|marioluciani}}
* {{User|nemo_bis}} (occasionally)
* {{User|Paolo Alberti}}
* {{User|robertolongo}}
* {{User|ste}}

=== ja - 日本語 - Japanese ===
* {{User|Koji Hijikuro}}
* {{User|Nori}}
* {{User|Richell}}
* {{User|Yama}}

=== nl - Nederlands - Dutch ===
* {{User|AboutTime}}
* {{User|Alex0703}}
* {{User|Annemiek}}
* {{User|Arkomat}}
* {{User|bcdesign}}
* {{User|crommie}}
* {{User|Grubosoft}}
* {{User|fcschippers}}
* {{User|HermanPeeren}}
* {{User|Hvdmeer}}
* {{User|janvankuijk}}
* {{User|John Flour}}
* {{User|JorSanders}}
* {{User|Josien}}
* {{User|Lara}}
* {{User|Lianne}}
* {{User|klatte88}}
* {{User|ManuAmpe}}
* {{User|Marcelk}}
* {{User|marionnijhuis}}
* {{User|Marnix}}
* {{User|MartijnM}}
* {{User|Meta}}
* {{User|metdick}}
* {{User|Mtb}}
* {{User|n9iels}}
* {{User|Nemphias}}
* {{User|Nico-van-Leeuwen}}
* {{User|Onderzoekspraktijk}}
* {{User|rachel73}}
* {{User|Renem}}
* {{User|Ries}}
* {{User|Rineke}}
* {{User|Schrijvers123}}
* {{User|slibbe}}
* {{User|Stitch123}}
* {{User|Vertaalbirdy}}
* {{User|webmiep}}
* {{User|webcatsolutions}}
* {{User|willoweb}}
* {{User|wimstrik}}

=== pl - Polski - Polish ===
* {{User|Derek}}
* {{User|justyna}}
* {{User|MiloW}}

=== pt - Português - Portuguese ===
* {{User|Djesus}}
* {{User|Horus_68}}
* {{User|Mansil}}
* {{User|Nunof}}
* {{User|NunoLopes}}
* {{User|Ricardo.fusco}}

=== pt-br - Português Brasil - Brazilian Portuguese ===
* {{User|Airton}}
* {{User|alangustavo}}
* {{User|AleMorettiSan}}
* {{User|Anabarcellos}}
* {{User|Ariadnepinheiro}}
* {{User|Belisards}}
* {{User|Dagoberto}}
* {{User|DiLeu}}
* {{User|Filipetorres}}
* {{User|Gleisonsoares}}
* {{User|Helvecio}}
* {{User|Henrydouglas}}
* {{User|Jeann Wilson}}
* {{User|Murilotimo}}
* {{User|VitorAdonai}}
* {{User|Vizetti}}
* {{User|Welkson Ramos}}

=== ro - Română - Romanian ===
* {{User|andreeastefan}}
* {{User|isac}}

=== ru - Русский - Russian ===
* {{User|AlexSmirnov}}
* {{User|Antonio3}}
* {{User|b2z}}
* {{User|Dosfanat}}
* {{User|Igor}}
* {{User|Kanta}}
* {{User|Leo240}}
* {{User|Nikitm}}
* {{User|Serg SSN}}
* {{User|Vyatka}}
* {{User|Yambergaa}}

=== si - සිංහල - Sinhala ===
* {{User|Yasirunilan}}
* {{User|Supun}}

=== sk - Slovenčina - Slovak ===
* {{User|adambako}}

=== sv - Svenska - Swedish ===
* {{User|Propellerhuvud}}
* {{User|Sgagner}}

=== sw - Kiswahili - Swahili ===
* {{User|Ayeko}}

=== th - ไทย - Thai ===
* {{User|Supachai_chai}}
* {{User|Mrs.siam}}
* {{User|Ariesanywhere}}

=== tr - Türkçe - Turkish ===
* {{User|Enes}}
* {{User|Ugur}}
* {{User|Umitkenan}}

=== ukr - Українська - Ukrainian ===
* {{User|Olesya6968ak}}
* {{User|sera527}}

=== ur - ur-PK - اردو - Urdu Pakistan ===
* {{User|hoornayyer}}

=== vi - Tiếng Việt - Vietnamese ===
* {{User|huyhoa}}

=== zh - 中文 - Chinese ===
* {{User|asika32764}}
* {{User|eyesofkids}}
* {{User|Guozhanfeng}}
* {{User|KellyXYM}}
* {{User|lai32290}}
* {{User|Mori0725ken}}
* {{User|myskies}}
* {{User|Wulijun01234}}
* {{User|Zace}}
* {{User|Zhang19min88}}
* {{User|Zhous98}}

==Translation Administrators==

The responsibilities of a Translation Administrator will require slightly more attention to the documents for translation. Translation Administrators should feel comfortable with using wiki markup, made hundreds of contributions to their specific language and assisted others in translation of docs. Administrators will need to check the documentation every few days and perform any required tasks. These tasks include re-marking pages in en-GB with edit changes, tracking language units which need translation and welcoming new translators. Ideally, we should have at least one Translation Administrator who will not be tied to any specific language and when the time comes, one Translation Administrator for active language teams.

===Current Volunteer Translation Administrators===
{{:Special:ListUsers/translationadmins}}

==Common Language Codes==
<div class="small-4 columns"> afr - Afrikaans - Afrikaans
</div><div class="small-4 columns"> ar - عربي - Arabic
</div><div class="small-4 columns"> bg - Български - Bulgarian
</div><div class="small-4 columns"> bg - Български - Bulgarian
</div><div class="small-4 columns"> bn - বাংলা - Bengali
</div><div class="small-4 columns"> bo - བོད་ཡིག - tibetan
</div><div class="small-4 columns"> ca - Català - Catalan
</div><div class="small-4 columns"> ce - Nohçi - Chechen
</div><div class="small-4 columns"> da - Dansk - Danish
</div><div class="small-4 columns"> de - Deutsch - German
</div><div class="small-4 columns"> es - Español - Spanish
</div><div class="small-4 columns"> fa - فارسی - Persian
</div><div class="small-4 columns"> fi - Suomi - Finnish
</div><div class="small-4 columns"> fr - Français - French
</div><div class="small-4 columns"> hu - Magyar - Hungarian
</div><div class="small-4 columns"> hy - Հայերեն - Armenian
</div><div class="small-4 columns"> id - Bahasa Indonesia - Indonesian
</div><div class="small-4 columns"> is - Íslenska - Icelandic
</div><div class="small-4 columns"> it - Italiano - Italian
</div><div class="small-4 columns"> ja - 日本語 - Japanese
</div><div class="small-4 columns"> ko - 한국어 - Korean
</div><div class="small-4 columns"> lb - Lëtzebuergesch - Luxembourgish
</div><div class="small-4 columns"> min - Baso Minangkabau - Minang
</div><div class="small-4 columns"> ml - liviox alvax - Malayalam
</div><div class="small-4 columns"> mr - मराठी - Marathi
</div><div class="small-4 columns"> ms - Bahasa Melayu - Malay
</div><div class="small-4 columns"> nl - Nederlands - Dutch
</div><div class="small-4 columns"> pl - Polski - Polish
</div><div class="small-4 columns"> pt - Português - Portuguese
</div><div class="small-4 columns"> pt-br - Português do Brasil - Brazilian Portuguese
</div><div class="small-4 columns"> ro - Română - Romanian
</div><div class="small-4 columns"> ru - Русский - Russian
</div><div class="small-4 columns"> sl - Slovenščina - Slovenianjtökók
</div><div class="small-4 columns"> sq - Shqip - Albanian
</div><div class="small-4 columns"> sv - Svenska - Swedish
</div><div class="small-4 columns"> sw - Kiswahili - Swahili
</div><div class="small-4 columns"> ta - தமிழ் - Tamil
</div><div class="small-4 columns"> th - ไทย - Thai
</div><div class="small-4 columns"> tr - Türkçe - Turkish
</div><div class="small-4 columns"> vi - Tiếng Việt - Vietnamese
</div><div class="small-4 columns"> zh - 中文 - Chinese
</div>

<noinclude>
[[Category:Documentation Wiki Policies and Guidelines]]
[[Category:Documentation Translation]]
</noinclude>