https://docs.sandbox.joomla.org/api.php?action=feedcontributions&feedformat=atom&user=UglyeoinJoomla! Documentation - User contributions [en]2026-05-19T12:00:58ZUser contributionsMediaWiki 1.43.0https://docs.sandbox.joomla.org/index.php?title=Joomla_3.x_to_4.x_Step_by_Step_Migration&diff=714642Joomla 3.x to 4.x Step by Step Migration2020-08-18T21:25:51Z<p>Uglyeoin: Got bullets working</p>
<hr />
<div>{{needs|needs updating|Upload screenshots}}<br />
<noinclude><languages /></noinclude><br />
{{warning|<translate><br />
<!--T:1--><br />
This guide assumes you are starting on Joomla 3.10.x. If you are on a earlier version make sure you upgrade to Joomla 3.10 first before moving to Joomla 4.</translate>}}<br />
<br />
<translate><br />
<!--T:2--><br />
The following are step by step instructions to migrate your 3.10.x site to Joomla! 4.x. While there are hundreds of different scenarios, this will give you the basic procedure to follow. Very complex migrations will likely be a result of installed third-party extensions. You are encouraged to contact the developers of third-party extensions installed on your Joomla site for their suggested path to migrate their extensions.<br />
</translate><br />
<translate><br />
<br />
== Intro == <!--T:3--><br />
The migration from Joomla! 3.10.x to 4.x is considered a mini-migration. This is because the Joomla! core extensions will upgrade with a “one-click” upgrade via the Joomla! Update component in the backend administrator side of Joomla. Many third-party extensions are a one-click upgrade too. Some are not. You need to look at each one and determine what path the extension needs to follow to get from 3.10 to 4.x. If you haven't already, you might be interested in reading the [[S:MyLanguage/Migration Step by Step Self Assessment|Self Assessment]] and [[S:MyLanguage/Planning for Mini-Migration - Joomla 3.10 to 4.x|Planning for 3.10 to 4.x Migration]] prior to following the steps below.<br />
<br />
<!--T:4--><br />
Joomla! Core Extensions:<br />
* Categories<br />
* Articles<br />
* Menus<br />
* Modules (core modules - not third-party)<br />
* Banners<br />
* Fields<br />
* Content History<br />
* Contacts<br />
* Messaging<br />
* Newsfeeds<br />
* Redirect<br />
* Search (decoupled in 4.x. Use Smart Search going forward. See Notes under Assess Each Extension)<br />
* Smart Search<br />
* Tags<br />
* Weblinks (decoupled but your site may be using it and it will migrate. See Notes under Assess Each Extension)<br />
</translate><br />
<translate><br />
<br />
== Step by Step == <!--T:5--><br />
=== Set up a Development Location ===<br />
</translate><br />
<translate><br />
<!--T:6--><br />
# Make sure you are running the latest Joomla 3.10.x version before proceeding.<br />
# Take a backup of your live 3.10.x site. You can use a suggested tool (see the ''Suggested Tools'' at the bottom of page) or you can do this manually.<br />
#*[[S:MyLanguage/Backup_Basics_for_a_Joomla!_Web_Site|Backup Basics for a Joomla! Web Site]]<br />
#*[[S:MyLanguage/What_are_the_best_practices_for_site_backups%3F|What are the best practices for site backups?]]<br />
# Make sure your environment meets the [https://downloads.joomla.org/technical-requirements technical requirements for Joomla 4] before proceeding.<br />
# Create a new database and new user to restore your 3.10.x site to. <br />
# Create a testing site or build area to work in and restore the backup copy of your 3.10.x site in one of the following places:<br />
#* A subdomain.<br />
#* A subdirectory.<br />
#* A local device. Joomla has a detailed tutorial on installing [http://sourceforge.net/projects/xampp/ XAMPP] at [[XAMPP]]. However [https://www.wampserver.com/en/ WAMP], [https://www.mamp.info/en/windows/ MAMP], [https://sourceforge.net/projects/lampas/ LAMP] are all suitable alternatives.<br />
#* A new hosting account on a temporary domain in the root. (If you would like to change hosts in the process of migration.)<br />
#** Restoring a site on a local device. See [[S:MyLanguage/Installing Joomla locally|Installing Joomla locally]] and [[S:MyLanguage/Setting up your workstation for Joomla development|Setting up your workstation for Joomla development]].<br />
#** Restoring a site with a tool listed at the bottom of the page. (Read the developer documentation.)<br />
# In your test location, update your Joomla! 3.10.x instance to the latest maintenance release.<br />
# Make sure you have the latest database schema updated to the latest version 3.10.x version by going to {{rarr|Extension Manager,Database}} tab. If your schema is not up to date as in the following image, click the '''Fix''' button:</translate>{{-}}[[File:J310-admin-extension-database-fix-<translate><br />
<!--T:7--><br />
en</translate>.png|border]]<br />
<translate><br />
<!--T:8--><br />
# Empty trash: Do you have any articles in the trash? If so, delete them (and any applicable media that may be associated with them if not in use elsewhere on the site). Articles (categories and menu items too) left in the trash can cause issues in having a migration to complete without errors.<br />
# Test.<br />
# Backup again.<br />
</translate><br />
<translate><br />
<br />
=== Assess Each Extension === <!--T:9--><br />
</translate><br />
<translate><br />
<!--T:10--><br />
In your [[Planning_for_Mini-Migration_-_Joomla_3.10_to_4.x|planning]], you determined which third-party extensions were staying or going and how they migrate. For this portion of the Step by Step, you’ll be using two different sections of the site extensively; The Pre-Update Check in {{rarr|Components,Joomla! Update}} and {{rarr|Extensions,Manage,Manage}}. You are going to be looking at every single extension installed on your site. You will be determining if they need to be updated to the latest version or uninstalled.<br />
<br />
<!--T:30--><br />
# Using the '''Pre-Update Check''': in order to use the Pre-Update Check, you will need to set the Joomla! Update component to Joomla 4. To do this follow:<br />
# Go to {{rarr|Components,Joomla Update}}. (It should say no updates found. If it doesn’t, update Joomla to the latest version (must be 3.10.x) and test. Then do another backup.) Click on the Options button at the top right corner.<br />
# Select ''Joomla Next'' (This is the current text - it may be different in the future) from the drop-down for Update server. <br />
Need an image just like below in go to j4 but the thing will not let me do it.<br />
# Click Save & Close<br />
# You will then see your Installed Joomla Version, the latest Joomla! version and the URL for the update package. Joomla will show you the requirements again for Joomla 4. If it flags that you have either an incompatible system or extensions it will tell you here. Take a moment to review this page. <br />
Need an image just like below in the going to 4 section but the thing will not let me do it.<br />
<br />
<!--T:31--><br />
BIG NOTE: DO NOT UPDATE TO JOOMLA! 4 RIGHT NOW. THIS IS ONLY TO PREPARE YOUR THIRD-PARTY EXTENSIONS AND GET THE SITE COMPATIBLE WITH JOOMLA 4.<br />
# Look at the Pre-Update Check and the Extension Pre-Update Check in the Pre-Update Check tab of the Joomla Update component. If any extension that isn’t in your planning is listed here, add it to your list of extensions to investigate.<br />
# If you migrated from Joomla! 2.5 to 3.x in the past, there may be some leftover extensions that need to be cleaned up. The following are older 2.5 or 3.x extensions that need to be uninstalled before updating to Joomla 4:<br />
## plg_content_geshi<br />
## Bluestork Administrator Template<br />
## Beez_20<br />
## Beez5<br />
## Atomic<br />
## When it comes to templates, uninstall all core frontend or backend templates except Protostar and Beez3 (frontend templates) and Isis or Hathor (administrator templates)<br />
## If you come across other files that need to be uninstalled, please add them to this page. This is a wiki so anyone can add to the page. Thank you in advance for your service.<br />
# You will notice the tags for whether an extension is compatible or not. These tags generally tell a true story if they say No or Yes. If they say “Missing Compatibility Tag” it means that the extension developer didn’t use a tag in their extension so we don’t know if it is or isn’t compatible with Joomla 4. Talk to the developer to verify.<br />
# '''Update Extensions''': update any extensions that you will keep in your website. In Joomla! 3.10.x you can go to {{rarr|Extension Manager,Update tab}} and click '''Find Updates''' which will add a tooltip in the Version column, under the Manage tab, giving some compatibility information from the backend. This functionality only supports extensions that update via the Extension Manager Update tab. If you have extensions installed that do not use the Joomla extension update they need to be assessed manually as detailed below. The same goes for those extensions that have a tooltip. You will still need to check the type of package and migration path with the extension developer to verify how to upgrade/migrate.<br />
# Uninstall and Investigate Extensions: go to {{rarr|Extension Manager,Manage tab}}<br />
# Click the drop-down for Type.<br />
# Select Package from the drop-down.</translate>{{-}}[[File:J310-admin-extension-manage-package-<translate><br />
<!--T:11--><br />
en</translate>.png|border]]{{-}}{{note|<translate><br />
<!--T:12--><br />
Selecting Package first is recommended because if there is something you need to uninstall in a package, it will automatically uninstall the associated Modules, Plugins, or anything else in the package at one time.</translate>}}<br />
<translate><br />
<!--T:13--><br />
# Uninstall any Packages that are no longer needed or will not be migrating to Joomla 4.<br />
# Repeat this process of going through the Manage tab for all Types in the drop-down: Component, File, Language, Library, Module, Plugin and Template. If the Author states Joomla! Project, then leave those extensions alone. For all others, make sure that you uninstall those not in use or not compatible with Joomla! 4.x.</translate>{{-}}{{note|<translate><br />
<!--T:14--><br />
'''NOTE!''' You will not be able to uninstall any template that is set as default. You will need to select a Core supported template like Beez3 or Protostar and then uninstall the template if you need to do so.</translate>|type=serious}}<br />
<translate><br />
<!--T:15--><br />
# Make a note of any versions of Packages and Components currently running that you will be keeping on your site. You can use the [https://docs.joomla.org/images/7/7a/3to4-Third-Party_Extension_Checklist_Inventory_Sheet.pdf Third Party Extension Checklist and Inventory Sheet] or just copy/paste them into a document for reference.<br />
# For any extensions you are keeping but don't use the Extension Manager to one-click update ({{rarr|Extensions,Manage,Update}}) update all extensions to the latest versions.<br />
# Before and as you update, note if the extensions have both 3.10.x & 4.x versions in the same package. If so, they will be fine to "one-click update." If not, and 3.10 and 4.x have different packages, you need to look at them case by case. They will normally fall into one of the following scenarios:<br />
#* The extension has separate packages but upon upgrading to 4.x, they automatically detect this and still work. Make sure the developer confirms this.<br />
#* The extension has separate packages that need to be uninstalled in 3.10.x and then installed with the Joomla 4.x version once the site is migrated. An example of this might be a content plugin. It is very simple to uninstall it in 3.10.x and then install it again in 4.x.<br />
#* See [[S:MyLanguage/Template_Considerations_During_Migration|Template Considerations]] for more specific information on templates and [[S:MyLanguage/J3.x:Converting_A_Previous_Joomla!_Version_Template|Converting a previous Joomla! Version template]]</translate><br />
<translate><br />
<br />
==== Notes on Search (com_search) ==== <!--T:32--><br />
Search (com_search) will be decoupled in Joomla 4.x. Search (com_search) will migrate to Joomla 4. After migration, you'll need to update it to the Joomla 4.x version via com_installer. It will continue to be maintained, but more the same way a third-party extension is by receiving updates via com_installer. It is recommended to use Smart Search (com_finder) going forward. Search will still be available at https://extensions.joomla.org/category/official-extensions/.<br />
<br />
==== Notes on Weblinks ==== <!--T:33--><br />
Weblinks was decoupled back in Joomla 3.4. If it was in use on a 2.5 site, the migration process would note this and migrate the Weblinks component and data. For the migration from 3.10.x to 4.x, it will be the same. It is still available and maintained on the JED at [https://extensions.joomla.org/category/official-extensions/ Official Extensions].<br />
<br />
=== Going to Joomla! 4.x === <!--T:16--><br />
Once you have either updated or uninstalled your third-party extensions so that only those compatible with Joomla! 4 remain in your installation, continue with the following steps:<br />
</translate><br />
<translate><br />
<!--T:17--><br />
# Go to {{rarr|Site,Global Configuration,Server tab}} and turn Error Reporting from System Default to Maximum. Make sure to Save & Close.</translate>{{-}} [[File:J310-system-global-config-server-tab-<translate><br />
<!--T:18--><br />
en</translate>.png|border|500px]]<br />
<translate><br />
<!--T:19--><br />
# Take another backup.<br />
# Go to {{rarr|Components,Joomla Update}}. (It should say no updates found. If it doesn’t, update Joomla to the latest version and test. Then do another backup.) Click on the Options button at the top right corner.<br />
# Select ''Joomla Next'' (This is the current text—it may be different in the future.) from the drop-down for Update server.</translate>{{-}}[[File:J310-component-joomla-update-select-support-<translate><br />
<!--T:20--><br />
en</translate>.png|border|500px]]<br />
<translate><br />
<!--T:21--><br />
# Click Save & Close.<br />
# You will then see your Installed Joomla Version, the Latest Joomla! version and the URL for the update package. Joomla will show you the requirements again for Joomla 4. If it flags that you have either an incompatible system or extensions it will tell you here. Take a moment to review this page.</translate>{{-}}[[File:J310-to-j4-dev-update-found-<translate><br />
<!--T:22--><br />
en</translate>.png|border]]<br />
<translate><br />
<!--T:23--><br />
# If the update is not showing up, go to {{rarr|Extension manager,Update}} and press Purge Cache from the toolbar. Now the update to Joomla! 4 should show up.<br />
# Cross your fingers, and make sure you have that backup available in case.<br />
# Click the Install the Update button.<br />
# Make tea whilst the spinning circle goes round and round. The amount of time the wheel spins is dependent on your site, Internet connection and server speed. The process takes about two minutes. When the update is finished, you will probably be logged out of the Administrator. Sign in again. Twice.<br />
# If all goes well, you will get to a totally new look to the backend administrator panel.</translate>{{-}}[[File:j4-administrator-overview-<translate><br />
<!--T:24--><br />
en</translate>.png|border]]<br />
<translate><br />
<!--T:25--><br />
# Click the Clear Cache button. You will now see a ''A Joomla update was found'' notice for a later version of Joomla. Postpone this update temporarily.<br />
# Go to {{rarr|Extensions,Manage,Database}} and click ''Fix'' if any errors show.<br />
# In the Extension Manager, go to Discover and see if there are any extensions to install. (There shouldn't be any!)<br />
# Go to the frontend of your site and see if it shows up even if it’s not the right template. If so, continue. If not, see [[S:MyLanguage/Joomla 3.10 to 4.x Common Migration Errors|common errors during migration]].<br />
# Take a backup.<br />
# Install your new template or other extensions if you have them to install. Back up often.<br />
# Configure them. Back up often.<br />
# Test everything. Back up often.<br />
# If everything works as expected, turn Error Reporting back to System Default ({{rarr|System,Global Configuration,Server tab}}). Make sure to Save & Close.<br />
</translate><br />
<translate><br />
<br />
=== Going Live with your Joomla! 4.x Site === <!--T:26--><br />
# When you’re ready to go live, back up your 3.10 site for the last time. Restore it in a subdirectory or subdomain if you would like to.<br />
# Back up your Joomla! 4.x site and move or restore your Joomla! 4.x site to the root (or change nameservers if you were building on a temporary domain at a new hosting account root).<br />
# Test again.<br />
# Remove the Joomla! 3.10 site from the server within a couple of days unless you have edited your ''robots.txt'' file to block the search engine spiders.<br />
# Remove all development sites you have been working with or keep them up-to-date if they are running a current version in order to ward off hack attempts on your server. <br />
<br />
<!--T:27--><br />
If you had data change on the 3.10 site while you were migrating to 4.x, you will want to get that data moved over to the 4.x site before going live. You can do this manually (make sure you keep the same user IDs - go in order) or by using a [https://extensions.joomla.org/category/migration-a-conversion/data-import-a-export%20transfer%20tool/third-party%20extension/ third party extension].<br />
</translate><br />
<translate><br />
<br />
== Suggested Tools == <!--T:28--><br />
* [http://extensions.joomla.org/extensions/access-a-security/site-security/backup/1606 Akeeba Backup] is very popular for backup and restore. See more [https://extensions.joomla.org/tags/backup/ backup tools].<br />
</translate><br />
<noinclude><br />
<translate><br />
<!--T:29--><br />
[[Category:Migration]]<br />
[[Category:Tutorials]]</translate></noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Joomla_Core_APIs&diff=680916J4.x:Joomla Core APIs2020-06-16T22:12:52Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.0}}</noinclude><br />
<translate><!--T:1--> This page lists the endpoints available in Joomla by example of curl commands.</translate><br />
<br />
<translate><!--T:2--> Every URL requires authentication unless designated a public URL. For security in Joomla 4.0.0 we plan to make the default Api Application require a Super User account (as the API Application is brand new), this may get relaxed as the API stabilizes and is well tested in the community. If you are using the basic authentication plugin (currently the only shipped plugin as of Joomla 4 alpha 10) it requires the addition to the curl commands below using --user user_name:password</translate><br />
<br />
<translate><!--T:3--> Every URL needs to be prepended with the Joomla host before the path (e.g. instead of <tt>/api/index.php/v1/article</tt> you need <tt><nowiki>http://example.com/api/index.php/v1/article</nowiki></tt>)</translate><br />
<br />
<translate><!--T:4--> Any names of properties in curly brackets ({}) indicate the property is a variable that should be substituted.</translate><br />
<br />
<translate><!--T:5--> Unless otherwise noted these APIs were introduced in Joomla 4. For more information on the Joomla API Specification (as opposed to this list of URLs and options) please visit the [[S:MyLanguage/Joomla Api Specification|Joomla Api Specification]].</translate><br />
<br />
<translate><br />
Where end points require the value of {app} the variable currently takes two values, site (front end), or administrator {back end)<br />
</translate><br />
<br />
<translate><br />
== Banners == <!--T:6--><br />
</translate><br />
<translate><br />
=== Banners === <!--T:7--><br />
</translate><br />
<translate><br />
==== Get List of Banners ==== <!--T:8--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners<br />
<translate><br />
==== Get Single Banner ==== <!--T:9--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/{banner_id}<br />
<translate><br />
==== Delete Banner ==== <!--T:10--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/{banner_id}<br />
<translate><br />
==== Create Banner ==== <!--T:11--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners -d <br />
<source lang="javascript"><br />
{<br />
"catid": 3,<br />
"clicks": 0,<br />
"custombannercode": "",<br />
"description": "Text",<br />
"metakey": "",<br />
"name": "Name",<br />
"params": {<br />
"alt": "",<br />
"height": "",<br />
"imageurl": "",<br />
"width": ""<br />
}<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Banner ==== <!--T:12--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/{banner_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "name",<br />
"catid": 3,<br />
"description": "New Text",<br />
"name": "New Name"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Clients === <!--T:13--><br />
</translate><br />
<translate><br />
==== Get List of Clients ==== <!--T:14--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/clients <br />
<br />
<translate><br />
==== Get Single Client ==== <!--T:15--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/clients/{client_id}<br />
<br />
<translate><br />
==== Delete Client ==== <!--T:16--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/clients/{client_id}<br />
<br />
<translate><br />
==== Create Client ==== <!--T:17--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners/clients -d <br />
<source lang="javascript"><br />
{<br />
"contact": "Name",<br />
"email": "email@mail.com",<br />
"extrainfo": "",<br />
"metakey": "",<br />
"name": "Clients",<br />
"state": 1<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Client ==== <!--T:18--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/clients/{client_id} -d <br />
<source lang="javascript"><br />
{<br />
"contact": "new Name",<br />
"email": "newemail@mail.com",<br />
"name": "Clients"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Categories === <!--T:19--><br />
</translate><br />
<translate><br />
==== Get List of Categories ==== <!--T:20--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/categories <br />
<br />
<translate><br />
==== Get Single Category ==== <!--T:21--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/categories/{category_id}<br />
<br />
<translate><br />
==== Delete Category ==== <!--T:22--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/categories/{category_id}<br />
<br />
<translate><br />
==== Create Category ==== <!--T:23--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners/categories -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"alias": "cat",<br />
"extension": "com_banners",<br />
"language": "*",<br />
"note": "",<br />
"parent_id": 1,<br />
"published": 1,<br />
"title": "Title",<br />
"params": {<br />
"workflow_id": 1<br />
}<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Category ==== <!--T:24--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/categories/{category_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "cat",<br />
"note": "Some Text",<br />
"parent_id": 1,<br />
"title": "New Title"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Content History === <!--T:25--><br />
</translate><br />
<translate><br />
==== Get List of Content Histories ==== <!--T:26--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/contenthistory/{banner_id}<br />
<br />
<translate><br />
==== Toggle Keep Content History ==== <!--T:27--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/contenthistory/keep/{contenthistory_id}<br />
<br />
<translate><br />
==== Delete Content History ==== <!--T:28--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/contenthistory/{contenthistory_id}<br />
<br />
<translate><br />
== Config == <!--T:29--><br />
</translate><br />
<translate><br />
=== Application === <!--T:30--><br />
</translate><br />
<translate><br />
==== Get List of Application Configs ==== <!--T:31--><br />
</translate><br />
curl -X GET /api/index.php/v1/config/application<br />
<br />
<translate><br />
==== Update Application Config ==== <!--T:32--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/config/application -d <br />
<source lang="javascript"><br />
{<br />
"debug": true,<br />
"sitename": "123"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Component === <!--T:33--><br />
</translate><br />
<translate><br />
==== Get List of Component Configs ==== <!--T:34--><br />
</translate><br />
curl -X GET /api/index.php/v1/config/{component_name}<br />
<br />
Example “component_name” is “com_content”.<br />
<br />
<translate><br />
==== Update Application Config ==== <!--T:35--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/config/application -d <br />
<source lang="javascript"><br />
{<br />
"link_titles": 1<br />
}<br />
</source><br />
<br />
<translate><br />
== Contact == <!--T:36--><br />
</translate><br />
<translate><br />
=== Contact === <!--T:37--><br />
</translate><br />
<translate><br />
==== Get List of Contacts ==== <!--T:38--><br />
</translate><br />
curl -X GET /api/index.php/v1/contact<br />
<br />
<translate><br />
==== Get Single Contact ==== <!--T:39--><br />
</translate><br />
curl -X GET /api/index.php/v1/contact/{contact_id}<br />
<br />
<translate><br />
==== Delete Contact ==== <!--T:40--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/contact/{contact_id}<br />
<br />
<translate><br />
==== Create Contact ==== <!--T:41--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/contact -d <br />
<source lang="javascript"><br />
{<br />
"alias": "contact",<br />
"catid": 4,<br />
"language": "*",<br />
"name": "Contact"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Contact ==== <!--T:42--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/contact/{contact_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "contact",<br />
"catid": 4,<br />
"name": "New Contact"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Submit Contact Form ==== <!--T:43--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/contact/form/{contact_id} -d <br />
<source lang="javascript"><br />
{<br />
"contact_email": "email@mail.com",<br />
"contact_message": "some text",<br />
"contact_name": "name",<br />
"contact_subject": "subject"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Categories === <!--T:44--><br />
</translate><br />
#<translate><!--T:45--> Route Contact Categories is</translate>: "v1/contact/categories"<br />
#<translate><!--T:46--> Working with it is similar to [[S:MyLanguage/#Categories|Banners Categories]].</translate><br />
<br />
<translate><br />
=== Fields Contact === <!--T:47--><br />
</translate><br />
<translate><br />
==== Get List of Fields Contact ==== <!--T:48--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/contact/contact<br />
<br />
<translate><br />
==== Get Single Field Contact ==== <!--T:49--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/contact/contact/{field_id}<br />
<br />
<translate><br />
==== Delete Field Contact ==== <!--T:50--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/fields/contact/contact/{field_id}<br />
<br />
<translate><br />
==== Create Field Contact ==== <!--T:51--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/fields/contact/contact -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"context": "com_contact.contact",<br />
"default_value": "",<br />
"description": "",<br />
"group_id": 0,<br />
"label": "contact field",<br />
"language": "*",<br />
"name": "contact-field",<br />
"note": "",<br />
"params": {<br />
"class": "",<br />
"display": "2",<br />
"display_readonly": "2",<br />
"hint": "",<br />
"label_class": "",<br />
"label_render_class": "",<br />
"layout": "",<br />
"prefix": "",<br />
"render_class": "",<br />
"show_on": "",<br />
"showlabel": "1",<br />
"suffix": ""<br />
},<br />
"required": 0,<br />
"state": 1,<br />
"title": "contact field",<br />
"type": "text"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Field Contact ==== <!--T:52--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/fields/contact/contact/{field_id} -d <br />
<source lang="javascript"><br />
{<br />
"title": "new contact field",<br />
"name": "contact-field",<br />
"label": "contact field",<br />
"default_value": "",<br />
"type": "text",<br />
"note": "",<br />
"description": "Some New Text"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Fields Contact Mail === <!--T:53--><br />
</translate><br />
#<translate><!--T:54--> Route Fields Contact Mail is:</translate> "v1/fields/contact/mail"<br />
#<translate><!--T:55--> Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Fields Contact Categories === <!--T:56--><br />
</translate><br />
#<translate><!--T:57--> Route Fields Contact Categories is:</translate> "v1/fields/contact/categories"<br />
#<translate><!--T:58--> Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Groups Fields Contact === <!--T:59--><br />
</translate><br />
<translate><br />
==== Get List of Groups Fields Contact ==== <!--T:60--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/groups/contact/contact<br />
<br />
<translate><br />
==== Get Single Group Fields Contact ==== <!--T:61--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/groups/contact/contact/{group_id}<br />
<br />
<translate><br />
==== Delete Group Fields Contact ==== <!--T:62--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/fields/groups/contact/contact/{group_id}<br />
<br />
<translate><br />
==== Create Group Fields Contact ==== <!--T:63--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/fields/groups/contact/contact -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"context": "com_contact.contact",<br />
"default_value": "",<br />
"description": "",<br />
"group_id": 0,<br />
"label": "contact field",<br />
"language": "*",<br />
"name": "contact-field3",<br />
"note": "",<br />
"params": {<br />
"class": "",<br />
"display": "2",<br />
"display_readonly": "2",<br />
"hint": "",<br />
"label_class": "",<br />
"label_render_class": "",<br />
"layout": "",<br />
"prefix": "",<br />
"render_class": "",<br />
"show_on": "",<br />
"showlabel": "1",<br />
"suffix": ""<br />
},<br />
"required": 0,<br />
"state": 1,<br />
"title": "contact field",<br />
"type": "text"<br />
}<br />
</source><br />
<translate><br />
==== Update Group Fields Contact ==== <!--T:64--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/fields/groups/contact/contact/{group_id} -d <br />
<source lang="javascript"><br />
{<br />
"title": "new contact group",<br />
"note": "",<br />
"description": "new description"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Group Fields Contact Mail === <!--T:65--><br />
</translate><br />
<translate><!--T:66--> #Route Group Fields Contact Mail is:</translate> "v1/fields/groups/contact/mail"<br />
<translate><!--T:67--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Group Fields Contact]].</translate><br />
<br />
<translate><br />
=== Group Fields Contact Categories=== <!--T:68--><br />
</translate><br />
<translate><!--T:69--> #Route Group Fields Contact Categories is:</translate> "v1/fields/groups/contact/categories"<br />
<translate><!--T:70--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Group Fields Contact]].</translate><br />
<br />
<translate><br />
=== Content History === <!--T:71--><br />
</translate><br />
<translate><!--T:72--> #Route Content History is:</translate> "v1/contact/contenthistory"<br />
<translate><!--T:73--> #Working with it is similar to [[S:MyLanguage/#Content_History|Banners Content History]].</translate><br />
<br />
<translate><br />
== Content == <!--T:74--><br />
</translate><br />
<translate><br />
=== Articles === <!--T:75--><br />
</translate><br />
<translate><br />
==== Get List of Articles ==== <!--T:76--><br />
</translate><br />
curl -X GET /api/index.php/v1/content/article<br />
<br />
<translate><br />
==== Get Single Article ==== <!--T:77--><br />
</translate><br />
curl -X GET /api/index.php/v1/content/article/{article_id}<br />
<br />
<translate><br />
==== Delete Article ==== <!--T:78--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/content/article/{article_id}<br />
<br />
<translate><br />
==== Create Article ==== <!--T:79--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/content/article -d <br />
<source lang="javascript"><br />
{<br />
"alias": "my-article",<br />
"articletext": "My text",<br />
"catid": 64,<br />
"language": "*",<br />
"metadesc": "",<br />
"metakey": "",<br />
"title": "Here's an article"<br />
}<br />
</source><br />
<br />
<translate><!--T:80--> Currently the options mentioned here are required properties. However the intention is currently to make AT LEAST metakey and metadesc optional in the API.</translate><br />
<br />
<translate><br />
==== Update Article ==== <!--T:81--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/content/article/{article_id} -d <br />
<source lang="javascript"><br />
{<br />
"catid": 64,<br />
"title": "Updated article"<br />
}<br />
</source><br />
<br />
<br />
<translate><br />
=== Categories === <!--T:82--><br />
</translate><br />
#Route Content Categories is: "v1/content/categories"<br />
#Working with it is similar to [[S:MyLanguage/#Categories|Banners Categories]].<br />
<br />
<translate><br />
<br />
=== Fields Articles === <!--T:83--><br />
</translate><br />
<translate><!--T:84--> #Route Fields Articles is:</translate> "v1/fields/content/articles"<br />
<translate><!--T:85--> #Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Groups Fields Articles === <!--T:86--><br />
</translate><br />
<translate><!--T:87--> #Route Groups Fields Articles is:</translate> "v1/fields/groups/content/articles"<br />
<translate><!--T:88--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Groups Fields Contact]].</translate><br />
<br />
<translate><br />
=== Fields Categories === <!--T:89--><br />
</translate><br />
<translate><!--T:90--> #Route Fields Categories is:</translate> "v1/fields/groups/content/categories"<br />
<translate><!--T:91--> #Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Content History === <!--T:92--><br />
</translate><br />
<translate><!--T:93--> #Route Content History is:</translate> "v1/content/article/contenthistory"<br />
<translate><!--T:94--> #Working with it is similar to [[S:MyLanguage/#Content_History|Banners Content History]].</translate><br />
<br />
<translate><br />
== Languages == <!--T:95--><br />
</translate><br />
<translate><br />
=== Languages === <!--T:96--><br />
</translate><br />
<translate><br />
==== Get List of Languages ==== <!--T:97--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages<br />
<br />
<translate><br />
==== Install Language ==== <!--T:98--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages -d <br />
<source lang="javascript"><br />
{<br />
"package": "pkg_fr-FR"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Content Languages === <!--T:99--><br />
</translate><br />
<translate><br />
==== Get List of Content Languages ==== <!--T:100--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages/content<br />
<br />
<translate><br />
==== Get Single Content Language ==== <!--T:101--><br />
</translate><br />
curl -X GET /api/index.php/v1/v1/languages/content/{language_id}<br />
<br />
<translate><br />
==== Delete Content Language ==== <!--T:102--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/languages/content/{language_id}<br />
<br />
<translate><br />
==== Create Content Language ==== <!--T:103--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/content -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"description": "",<br />
"image": "fr_FR",<br />
"lang_code": "fr-FR",<br />
"metadesc": "",<br />
"metakey": "",<br />
"ordering": 1,<br />
"published": 0,<br />
"sef": "fk",<br />
"sitename": "",<br />
"title": "French (FR)",<br />
"title_native": "Français (France)"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Content Language ==== <!--T:104--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/languages/content/{language_id} -d <br />
<source lang="javascript"><br />
{<br />
"description": "",<br />
"lang_code": "en-GB",<br />
"metadesc": "",<br />
"metakey": "",<br />
"sitename": "",<br />
"title": "English (en-GB)",<br />
"title_native": "English (United Kingdom)"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Overrides Languages === <!--T:105--><br />
</translate><br />
<translate><br />
==== Get List of Overrides Languages Constants ==== <!--T:106--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages/overrides/{app}/{lang_code}<br />
<br />
<translate><br />
==== Get Single Override Language Constant ==== <!--T:107--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id}<br />
<br />
<translate><br />
==== Delete Content Language ==== <!--T:108--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id}<br />
<br />
<translate><br />
==== Create Content Language ==== <!--T:109--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/{app}/{lang_code} -d <br />
<source lang="javascript"><br />
{<br />
"key":"new_key",<br />
"override": "text"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Content Language ==== <!--T:110--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id} -d <br />
<source lang="javascript"><br />
{<br />
"key":"new_key",<br />
"override": "new text"<br />
}<br />
</source><br />
<br />
var app - enum {"site", "administrator"}<br />
<br />
var lang_code - string Example: “fr-FR“, “en-GB“ you can get lang_code from v1/languages/content<br />
<br />
<translate><br />
==== Search Override Constant ==== <!--T:111--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/search -d <br />
<source lang="javascript"><br />
{<br />
"searchstring": "JLIB_APPLICATION_ERROR_SAVE_FAILED",<br />
"searchtype": "constant"<br />
}<br />
</source><br />
<br />
<translate><!--T:112--> var searchtype - enum {“constant”, “value”}. “constant” search by constant name, “value” - search by constant value</translate><br />
<br />
<translate><br />
==== Refresh Override Search Cache ==== <!--T:113--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/search/cache/refresh<br />
<br />
<translate><br />
== Menus == <!--T:114--><br />
</translate><br />
<translate><br />
=== Menus === <!--T:115--><br />
</translate><br />
<translate><br />
==== Get List of Menus ==== <!--T:116--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}<br />
<br />
<translate><br />
==== Get Single Menu ==== <!--T:117--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/{menu_id}<br />
<br />
<translate><br />
==== Delete Menu ==== <!--T:118--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/menus/{app}/{menu_id}<br />
<br />
<translate><br />
==== Create Menu ==== <!--T:119--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/menus/{app} -d <br />
<source lang="javascript"><br />
{<br />
"client_id": 0,<br />
"description": "The menu for the site",<br />
"menutype": "menu",<br />
"title": "Menu"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Menu ==== <!--T:120--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/{menu_id} -d <br />
<source lang="javascript"><br />
{<br />
"menutype": "menu",<br />
"title": "New Menu"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Menus Items === <!--T:121--><br />
</translate><br />
<translate><br />
==== Get List of Menus Items Types ==== <!--T:122--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/items/types<br />
<br />
<translate><br />
==== Get List of Menus Items ==== <!--T:123--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/items<br />
<br />
<translate><br />
==== Get Single Menu Item ==== <!--T:124--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/items/{menu_item_id}<br />
<br />
<translate><br />
==== Delete Menu Item ==== <!--T:125--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/menus/{app}/items/{menu_item_id}<br />
<br />
<translate><br />
==== Create Menu Item ==== <!--T:126--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/items -d <br />
<source lang="javascript"><br />
{<br />
"access": "1",<br />
"alias": "",<br />
"associations": {<br />
"en-GB": "",<br />
"fr-FR": ""<br />
},<br />
"browserNav": "0",<br />
"component_id": "20",<br />
"home": "0",<br />
"language": "*",<br />
"link": "index.php?option=com_content&view=form&layout=edit",<br />
"menutype": "mainmenu",<br />
"note": "",<br />
"params": {<br />
"cancel_redirect_menuitem": "",<br />
"catid": "",<br />
"custom_cancel_redirect": "0",<br />
"enable_category": "0",<br />
"menu-anchor_css": "",<br />
"menu-anchor_title": "",<br />
"menu-meta_description": "",<br />
"menu-meta_keywords": "",<br />
"menu_image": "",<br />
"menu_image_css": "",<br />
"menu_show": "1",<br />
"menu_text": "1",<br />
"page_heading": "",<br />
"page_title": "",<br />
"pageclass_sfx": "",<br />
"redirect_menuitem": "",<br />
"robots": "",<br />
"show_page_heading": ""<br />
},<br />
"parent_id": "1",<br />
"publish_down": "",<br />
"publish_up": "",<br />
"published": "1",<br />
"template_style_id": "0",<br />
"title": "title",<br />
"toggle_modules_assigned": "1",<br />
"toggle_modules_published": "1",<br />
"type": "component"<br />
}<br />
</source><br />
<br />
<translate><!--T:127--> Example for "Create Article Page"</translate><br />
<br />
<translate><br />
==== Update Menu Item ==== <!--T:128--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/items/{menu_item_id} -d <br />
<source lang="javascript"><br />
{<br />
"component_id": "20",<br />
"language": "*",<br />
"link": "index.php?option=com_content&view=form&layout=edit",<br />
"menutype": "mainmenu",<br />
"note": "",<br />
"title": "new title",<br />
"type": "component"<br />
}<br />
</source><br />
<br />
<translate><!--T:129--> Example for "Create Article Page"</translate><br />
<br />
<translate><br />
== Messages == <!--T:130--><br />
</translate><br />
<translate><br />
=== Messages === <!--T:131--><br />
</translate><br />
<translate><br />
==== Get List of Messages ==== <!--T:132--><br />
</translate><br />
curl -X GET /api/index.php/v1/messages<br />
<br />
<translate><br />
==== Get Single Message ==== <!--T:133--><br />
</translate><br />
curl -X GET /api/index.php/v1/messages/{message_id}<br />
<br />
<translate><br />
==== Delete Message ==== <!--T:134--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/messages/{message_id}<br />
<br />
<translate><br />
==== Create Message ==== <!--T:135--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/messages -d <br />
<source lang="javascript"><br />
{<br />
"message": "<p>text</p>",<br />
"state": 0,<br />
"subject": "text",<br />
"user_id_from": 773,<br />
"user_id_to": 772<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Message ==== <!--T:136--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/messages/{message_id} -d <br />
<source lang="javascript"><br />
{<br />
"message": "<p>new text</p>",<br />
"subject": "new text",<br />
"user_id_from": 773,<br />
"user_id_to": 772<br />
}<br />
</source><br />
<br />
<translate><br />
== Modules == <!--T:137--><br />
</translate><br />
<translate><br />
=== Modules === <!--T:138--><br />
</translate><br />
<translate><br />
==== Get List of Modules Types ==== <!--T:139--><br />
</translate><br />
curl -X GET /api/index.php/v1/modules/types/{app}<br />
<br />
<translate><br />
==== Get List of Modules ==== <!--T:140--><br />
</translate><br />
curl -X GET /api/index.php/v1/modules/{app}<br />
<br />
<translate><br />
==== Get Single Module ==== <!--T:141--><br />
</translate><br />
curl -X GET /api/index.php/v1/modules/{app}/{module_id}<br />
<br />
<translate><br />
==== Delete Module ==== <!--T:142--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/modules/{app}/{module_id}<br />
<br />
<translate><br />
==== Create Module ==== <!--T:143--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/modules/{app} -d <br />
<source lang="javascript"><br />
{<br />
"access": "1",<br />
"assigned": [<br />
"101",<br />
"105"<br />
],<br />
"assignment": "0",<br />
"client_id": "0",<br />
"language": "*",<br />
"module": "mod_articles_archive",<br />
"note": "",<br />
"ordering": "1",<br />
"params": {<br />
"bootstrap_size": "0",<br />
"cache": "1",<br />
"cache_time": "900",<br />
"cachemode": "static",<br />
"count": "10",<br />
"header_class": "",<br />
"header_tag": "h3",<br />
"layout": "_:default",<br />
"module_tag": "div",<br />
"moduleclass_sfx": "",<br />
"style": "0"<br />
},<br />
"position": "",<br />
"publish_down": "",<br />
"publish_up": "",<br />
"published": "1",<br />
"showtitle": "1",<br />
"title": "Title"<br />
}<br />
</source><br />
<br />
<translate><!--T:144--> Example for "Articles - Archived"</translate><br />
<br />
<translate><br />
==== Update Module ==== <!--T:145--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/modules/{app}/{module_id} -d <br />
<source lang="javascript"><br />
{<br />
"access": "1",<br />
"client_id": "0",<br />
"language": "*",<br />
"module": "mod_articles_archive",<br />
"note": "",<br />
"ordering": "1",<br />
"title": "New Title"<br />
}<br />
</source><br />
<br />
<noinclude>Example for "Articles - Archived"</noinclude><br />
<br />
<translate><br />
== Newsfeeds == <!--T:146--><br />
</translate><br />
<translate><br />
=== Feeds === <!--T:147--><br />
</translate><br />
<translate><br />
==== Get List of Feeds ==== <!--T:148--><br />
</translate><br />
curl -X GET /api/index.php/v1/newsfeeds/feeds<br />
<br />
<translate><br />
==== Get Single Feed ==== <!--T:149--><br />
</translate><br />
curl -X GET /api/index.php/v1/newsfeeds/feeds/{feed_id}<br />
<br />
<translate><br />
==== Delete Feed ==== <!--T:150--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/newsfeeds/feeds/{feed_id}<br />
<br />
<translate><br />
==== Create Feed ==== <!--T:151--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/newsfeeds/feeds -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"alias": "alias",<br />
"catid": 5,<br />
"description": "",<br />
"images": {<br />
"float_first": "",<br />
"float_second": "",<br />
"image_first": "",<br />
"image_first_alt": "",<br />
"image_first_caption": "",<br />
"image_second": "",<br />
"image_second_alt": "",<br />
"image_second_caption": ""<br />
},<br />
"language": "*",<br />
"link": "http://samoylov/joomla/gsoc19_webservices/index.php",<br />
"metadata": {<br />
"hits": "",<br />
"rights": "",<br />
"robots": "",<br />
"tags": {<br />
"tags": "",<br />
"typeAlias": null<br />
}<br />
},<br />
"metadesc": "",<br />
"metakey": "",<br />
"name": "Name",<br />
"ordering": 1,<br />
"params": {<br />
"feed_character_count": "",<br />
"feed_display_order": "",<br />
"newsfeed_layout": "",<br />
"show_feed_description": "",<br />
"show_feed_image": "",<br />
"show_item_description": ""<br />
},<br />
"published": 1<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Feed ==== <!--T:152--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/newsfeeds/feeds/{feed_id} -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"alias": "test2",<br />
"catid": 5,<br />
"description": "",<br />
"link": "http://samoylov/joomla/gsoc19_webservices/index.php",<br />
"metadesc": "",<br />
"metakey": "",<br />
"name": "Test"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Categories === <!--T:153--><br />
</translate><br />
<translate><!--T:154--> #Route Newsfeeds Categories is:</translate> "v1/newsfeeds/categories"<br />
<translate><!--T:155--> #Working with it is similar to [[S:MyLanguage/#Categories|Banners Categories]].</translate><br />
<br />
<translate><br />
== Privacy == <!--T:156--><br />
</translate><br />
<translate><br />
=== Request === <!--T:157--><br />
</translate><br />
<translate><br />
==== Get List of Requests ==== <!--T:158--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/request<br />
<br />
<translate><br />
==== Get Single Request ==== <!--T:159--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/request/{request_id}<br />
<br />
<translate><br />
==== Get Single Request Export Data ==== <!--T:160--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/request/export/{request_id}<br />
<br />
<translate><br />
==== Create Request ==== <!--T:161--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/privacy/request -d <br />
<source lang="javascript"><br />
{<br />
"email":"somenewemail@com.ua",<br />
"request_type":"export"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Consent === <!--T:162--><br />
</translate><br />
<translate><br />
==== Get List of Consents ==== <!--T:163--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/consent<br />
<br />
<translate><br />
==== Get Single Consent ==== <!--T:164--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/consent/{consent_id}<br />
<br />
<translate><br />
==== Delete Consent ==== <!--T:165--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/privacy/consent/{consent_id}<br />
<br />
<translate><br />
== Redirect == <!--T:166--><br />
</translate><br />
<translate><br />
=== Redirect === <!--T:167--><br />
</translate><br />
<translate><br />
==== Get List of Redirects ==== <!--T:168--><br />
</translate><br />
curl -X GET /api/index.php/v1/redirect<br />
<br />
<translate><br />
==== Get Single Redirect ==== <!--T:169--><br />
</translate><br />
curl -X GET /api/index.php/v1/redirect/{redirect_id}<br />
<br />
<translate><br />
==== Delete Redirect ==== <!--T:170--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/redirect/{redirect_id}<br />
<br />
<translate><br />
==== Create Redirect ==== <!--T:171--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/redirect -d <br />
<source lang="javascript"><br />
{<br />
"comment": "",<br />
"header": 301,<br />
"hits": 0,<br />
"new_url": "/content/art/99",<br />
"old_url": "/content/art/12",<br />
"published": 1,<br />
"referer": ""<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Redirect ==== <!--T:172--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/redirect/{redirect_id} -d <br />
<source lang="javascript"><br />
{<br />
"new_url": "/content/art/4",<br />
"old_url": "/content/art/132"<br />
}<br />
</source><br />
<br />
<translate><br />
== Tags == <!--T:173--><br />
</translate><br />
<translate><br />
=== Tags === <!--T:174--><br />
</translate><br />
<translate><br />
==== Get List of Tags ==== <!--T:175--><br />
</translate><br />
curl -X GET /api/index.php/v1/tags<br />
<br />
<translate><br />
==== Get Single Tag ==== <!--T:176--><br />
</translate><br />
curl -X GET /api/index.php/v1/tags/{tag_id}<br />
<br />
<translate><br />
==== Delete Tag ==== <!--T:177--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/tags/{tag_id}<br />
<br />
<translate><br />
==== Create Tag ==== <!--T:178--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/tags -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"access_title": "Public",<br />
"alias": "test",<br />
"description": "",<br />
"language": "*",<br />
"note": "",<br />
"parent_id": 1,<br />
"path": "test",<br />
"published": 1,<br />
"title": "test"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Tag ==== <!--T:179--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/tags/{tag_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "test",<br />
"title": "new title"<br />
}<br />
</source><br />
<br />
<translate><br />
== Templates == <!--T:180--><br />
</translate><br />
<translate><br />
=== Templates Styles === <!--T:181--><br />
</translate><br />
<translate><br />
==== Get List of Templates Styles ==== <!--T:182--><br />
</translate><br />
curl -X GET /api/index.php/v1/templates/styles/{app}<br />
<br />
<translate><br />
==== Get Single Template Style ==== <!--T:183--><br />
</translate><br />
curl -X GET /api/index.php/v1/templates/styles/{app}/{template_style_id}<br />
<br />
<translate><br />
==== Delete Template Style ==== <!--T:184--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/templates/styles/{app}/{template_style_id}<br />
<br />
<translate><br />
==== Create Template Style ==== <!--T:185--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/templates/styles/{app} -d <br />
<source lang="javascript"><br />
{<br />
"home": "0",<br />
"params": {<br />
"fluidContainer": "0",<br />
"logoFile": "",<br />
"sidebarLeftWidth": "3",<br />
"sidebarRightWidth": "3"<br />
},<br />
"template": "cassiopeia",<br />
"title": "cassiopeia - Some Text"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Template Style ==== <!--T:186--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/templates/styles/{app}/{template_style_id} -d <br />
<source lang="javascript"><br />
{<br />
"template": "cassiopeia",<br />
"title": "new cassiopeia - Default"<br />
}<br />
</source><br />
<br />
<translate><br />
== Users == <!--T:187--><br />
</translate><br />
<translate><br />
=== Users === <!--T:188--><br />
</translate><br />
<translate><br />
==== Get List of Users ==== <!--T:189--><br />
</translate><br />
curl -X GET /api/index.php/v1/users<br />
<br />
<translate><br />
==== Get Single User ==== <!--T:190--><br />
</translate><br />
curl -X GET /api/index.php/v1/users/{user_id}<br />
<br />
<translate><br />
==== Delete User ==== <!--T:191--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/users/{user_id}<br />
<br />
<translate><br />
==== Create User ==== <!--T:192--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/users -d <br />
<source lang="javascript"><br />
{<br />
"block": "0",<br />
"email": "test@mail.com",<br />
"groups": [<br />
"2"<br />
],<br />
"id": "0",<br />
"lastResetTime": "",<br />
"lastvisitDate": "",<br />
"name": "nnn",<br />
"params": {<br />
"admin_language": "",<br />
"admin_style": "",<br />
"editor": "",<br />
"helpsite": "",<br />
"language": "",<br />
"timezone": ""<br />
},<br />
"password": "qwerty",<br />
"password2": "qwerty",<br />
"registerDate": "",<br />
"requireReset": "0",<br />
"resetCount": "0",<br />
"sendEmail": "0",<br />
"username": "ad"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update User ==== <!--T:193--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/users/{user_id} -d <br />
<source lang="javascript"><br />
{<br />
"email": "new@mail.com",<br />
"groups": [<br />
"2"<br />
],<br />
"name": "name",<br />
"username": "username"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Fields Users === <!--T:194--><br />
</translate><br />
<translate><!--T:195--> #Route Fields Users is:</translate> "v1/fields/users"<br />
<translate><!--T:196--> #Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Groups Fields Users === <!--T:197--><br />
</translate><br />
<translate><!--T:198--> #Route Groups Fields Users is:</translate> "v1/fields/groups/users"<br />
<translate><!--T:199--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Groups Fields Contact]].</translate><br />
<br />
<noinclude><br />
[[Category:Development{{#translation:}}]]<br />
[[Category:Joomla!_4.x{{#translation:}}]]<br />
[[Category:Joomla!_4.0{{#translation:}}]]<br />
[[Category:Joomla!_Api{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Joomla_Core_APIs&diff=680915J4.x:Joomla Core APIs2020-06-16T22:12:16Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.0}}</noinclude><br />
<translate><!--T:1--> This page lists the endpoints available in Joomla by example of curl commands.</translate><br />
<br />
<translate><!--T:2--> Every URL requires authentication unless designated a public URL. For security in Joomla 4.0.0 we plan to make the default Api Application require a Super User account (as the API Application is brand new), this may get relaxed as the API stabilizes and is well tested in the community. If you are using the basic authentication plugin (currently the only shipped plugin as of Joomla 4 alpha 10) it requires the addition to the curl commands below using --user user_name:password</translate><br />
<br />
<translate><!--T:3--> Every URL needs to be prepended with the Joomla host before the path (e.g. instead of <tt>/api/index.php/v1/article</tt> you need <tt><nowiki>http://example.com/api/index.php/v1/article</nowiki></tt>)</translate><br />
<br />
<translate><!--T:4--> Any names of properties in curly brackets ({}) indicate the property is a variable that should be substituted.</translate><br />
<br />
<translate><!--T:5--> Unless otherwise noted these APIs were introduced in Joomla 4. For more information on the Joomla API Specification (as opposed to this list of URLs and options) please visit the [[S:MyLanguage/Joomla Api Specification|Joomla Api Specification]].</translate><br />
<br />
<translate><br />
Where end points require the value of {app} currently takes two values, site (front end), or administrator {back end)<br />
</translate><br />
<br />
<translate><br />
== Banners == <!--T:6--><br />
</translate><br />
<translate><br />
=== Banners === <!--T:7--><br />
</translate><br />
<translate><br />
==== Get List of Banners ==== <!--T:8--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners<br />
<translate><br />
==== Get Single Banner ==== <!--T:9--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/{banner_id}<br />
<translate><br />
==== Delete Banner ==== <!--T:10--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/{banner_id}<br />
<translate><br />
==== Create Banner ==== <!--T:11--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners -d <br />
<source lang="javascript"><br />
{<br />
"catid": 3,<br />
"clicks": 0,<br />
"custombannercode": "",<br />
"description": "Text",<br />
"metakey": "",<br />
"name": "Name",<br />
"params": {<br />
"alt": "",<br />
"height": "",<br />
"imageurl": "",<br />
"width": ""<br />
}<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Banner ==== <!--T:12--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/{banner_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "name",<br />
"catid": 3,<br />
"description": "New Text",<br />
"name": "New Name"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Clients === <!--T:13--><br />
</translate><br />
<translate><br />
==== Get List of Clients ==== <!--T:14--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/clients <br />
<br />
<translate><br />
==== Get Single Client ==== <!--T:15--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/clients/{client_id}<br />
<br />
<translate><br />
==== Delete Client ==== <!--T:16--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/clients/{client_id}<br />
<br />
<translate><br />
==== Create Client ==== <!--T:17--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners/clients -d <br />
<source lang="javascript"><br />
{<br />
"contact": "Name",<br />
"email": "email@mail.com",<br />
"extrainfo": "",<br />
"metakey": "",<br />
"name": "Clients",<br />
"state": 1<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Client ==== <!--T:18--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/clients/{client_id} -d <br />
<source lang="javascript"><br />
{<br />
"contact": "new Name",<br />
"email": "newemail@mail.com",<br />
"name": "Clients"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Categories === <!--T:19--><br />
</translate><br />
<translate><br />
==== Get List of Categories ==== <!--T:20--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/categories <br />
<br />
<translate><br />
==== Get Single Category ==== <!--T:21--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/categories/{category_id}<br />
<br />
<translate><br />
==== Delete Category ==== <!--T:22--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/categories/{category_id}<br />
<br />
<translate><br />
==== Create Category ==== <!--T:23--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/banners/categories -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"alias": "cat",<br />
"extension": "com_banners",<br />
"language": "*",<br />
"note": "",<br />
"parent_id": 1,<br />
"published": 1,<br />
"title": "Title",<br />
"params": {<br />
"workflow_id": 1<br />
}<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Category ==== <!--T:24--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/categories/{category_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "cat",<br />
"note": "Some Text",<br />
"parent_id": 1,<br />
"title": "New Title"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Content History === <!--T:25--><br />
</translate><br />
<translate><br />
==== Get List of Content Histories ==== <!--T:26--><br />
</translate><br />
curl -X GET /api/index.php/v1/banners/contenthistory/{banner_id}<br />
<br />
<translate><br />
==== Toggle Keep Content History ==== <!--T:27--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/banners/contenthistory/keep/{contenthistory_id}<br />
<br />
<translate><br />
==== Delete Content History ==== <!--T:28--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/banners/contenthistory/{contenthistory_id}<br />
<br />
<translate><br />
== Config == <!--T:29--><br />
</translate><br />
<translate><br />
=== Application === <!--T:30--><br />
</translate><br />
<translate><br />
==== Get List of Application Configs ==== <!--T:31--><br />
</translate><br />
curl -X GET /api/index.php/v1/config/application<br />
<br />
<translate><br />
==== Update Application Config ==== <!--T:32--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/config/application -d <br />
<source lang="javascript"><br />
{<br />
"debug": true,<br />
"sitename": "123"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Component === <!--T:33--><br />
</translate><br />
<translate><br />
==== Get List of Component Configs ==== <!--T:34--><br />
</translate><br />
curl -X GET /api/index.php/v1/config/{component_name}<br />
<br />
Example “component_name” is “com_content”.<br />
<br />
<translate><br />
==== Update Application Config ==== <!--T:35--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/config/application -d <br />
<source lang="javascript"><br />
{<br />
"link_titles": 1<br />
}<br />
</source><br />
<br />
<translate><br />
== Contact == <!--T:36--><br />
</translate><br />
<translate><br />
=== Contact === <!--T:37--><br />
</translate><br />
<translate><br />
==== Get List of Contacts ==== <!--T:38--><br />
</translate><br />
curl -X GET /api/index.php/v1/contact<br />
<br />
<translate><br />
==== Get Single Contact ==== <!--T:39--><br />
</translate><br />
curl -X GET /api/index.php/v1/contact/{contact_id}<br />
<br />
<translate><br />
==== Delete Contact ==== <!--T:40--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/contact/{contact_id}<br />
<br />
<translate><br />
==== Create Contact ==== <!--T:41--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/contact -d <br />
<source lang="javascript"><br />
{<br />
"alias": "contact",<br />
"catid": 4,<br />
"language": "*",<br />
"name": "Contact"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Contact ==== <!--T:42--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/contact/{contact_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "contact",<br />
"catid": 4,<br />
"name": "New Contact"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Submit Contact Form ==== <!--T:43--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/contact/form/{contact_id} -d <br />
<source lang="javascript"><br />
{<br />
"contact_email": "email@mail.com",<br />
"contact_message": "some text",<br />
"contact_name": "name",<br />
"contact_subject": "subject"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Categories === <!--T:44--><br />
</translate><br />
#<translate><!--T:45--> Route Contact Categories is</translate>: "v1/contact/categories"<br />
#<translate><!--T:46--> Working with it is similar to [[S:MyLanguage/#Categories|Banners Categories]].</translate><br />
<br />
<translate><br />
=== Fields Contact === <!--T:47--><br />
</translate><br />
<translate><br />
==== Get List of Fields Contact ==== <!--T:48--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/contact/contact<br />
<br />
<translate><br />
==== Get Single Field Contact ==== <!--T:49--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/contact/contact/{field_id}<br />
<br />
<translate><br />
==== Delete Field Contact ==== <!--T:50--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/fields/contact/contact/{field_id}<br />
<br />
<translate><br />
==== Create Field Contact ==== <!--T:51--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/fields/contact/contact -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"context": "com_contact.contact",<br />
"default_value": "",<br />
"description": "",<br />
"group_id": 0,<br />
"label": "contact field",<br />
"language": "*",<br />
"name": "contact-field",<br />
"note": "",<br />
"params": {<br />
"class": "",<br />
"display": "2",<br />
"display_readonly": "2",<br />
"hint": "",<br />
"label_class": "",<br />
"label_render_class": "",<br />
"layout": "",<br />
"prefix": "",<br />
"render_class": "",<br />
"show_on": "",<br />
"showlabel": "1",<br />
"suffix": ""<br />
},<br />
"required": 0,<br />
"state": 1,<br />
"title": "contact field",<br />
"type": "text"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Field Contact ==== <!--T:52--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/fields/contact/contact/{field_id} -d <br />
<source lang="javascript"><br />
{<br />
"title": "new contact field",<br />
"name": "contact-field",<br />
"label": "contact field",<br />
"default_value": "",<br />
"type": "text",<br />
"note": "",<br />
"description": "Some New Text"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Fields Contact Mail === <!--T:53--><br />
</translate><br />
#<translate><!--T:54--> Route Fields Contact Mail is:</translate> "v1/fields/contact/mail"<br />
#<translate><!--T:55--> Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Fields Contact Categories === <!--T:56--><br />
</translate><br />
#<translate><!--T:57--> Route Fields Contact Categories is:</translate> "v1/fields/contact/categories"<br />
#<translate><!--T:58--> Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Groups Fields Contact === <!--T:59--><br />
</translate><br />
<translate><br />
==== Get List of Groups Fields Contact ==== <!--T:60--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/groups/contact/contact<br />
<br />
<translate><br />
==== Get Single Group Fields Contact ==== <!--T:61--><br />
</translate><br />
curl -X GET /api/index.php/v1/fields/groups/contact/contact/{group_id}<br />
<br />
<translate><br />
==== Delete Group Fields Contact ==== <!--T:62--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/fields/groups/contact/contact/{group_id}<br />
<br />
<translate><br />
==== Create Group Fields Contact ==== <!--T:63--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/fields/groups/contact/contact -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"context": "com_contact.contact",<br />
"default_value": "",<br />
"description": "",<br />
"group_id": 0,<br />
"label": "contact field",<br />
"language": "*",<br />
"name": "contact-field3",<br />
"note": "",<br />
"params": {<br />
"class": "",<br />
"display": "2",<br />
"display_readonly": "2",<br />
"hint": "",<br />
"label_class": "",<br />
"label_render_class": "",<br />
"layout": "",<br />
"prefix": "",<br />
"render_class": "",<br />
"show_on": "",<br />
"showlabel": "1",<br />
"suffix": ""<br />
},<br />
"required": 0,<br />
"state": 1,<br />
"title": "contact field",<br />
"type": "text"<br />
}<br />
</source><br />
<translate><br />
==== Update Group Fields Contact ==== <!--T:64--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/fields/groups/contact/contact/{group_id} -d <br />
<source lang="javascript"><br />
{<br />
"title": "new contact group",<br />
"note": "",<br />
"description": "new description"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Group Fields Contact Mail === <!--T:65--><br />
</translate><br />
<translate><!--T:66--> #Route Group Fields Contact Mail is:</translate> "v1/fields/groups/contact/mail"<br />
<translate><!--T:67--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Group Fields Contact]].</translate><br />
<br />
<translate><br />
=== Group Fields Contact Categories=== <!--T:68--><br />
</translate><br />
<translate><!--T:69--> #Route Group Fields Contact Categories is:</translate> "v1/fields/groups/contact/categories"<br />
<translate><!--T:70--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Group Fields Contact]].</translate><br />
<br />
<translate><br />
=== Content History === <!--T:71--><br />
</translate><br />
<translate><!--T:72--> #Route Content History is:</translate> "v1/contact/contenthistory"<br />
<translate><!--T:73--> #Working with it is similar to [[S:MyLanguage/#Content_History|Banners Content History]].</translate><br />
<br />
<translate><br />
== Content == <!--T:74--><br />
</translate><br />
<translate><br />
=== Articles === <!--T:75--><br />
</translate><br />
<translate><br />
==== Get List of Articles ==== <!--T:76--><br />
</translate><br />
curl -X GET /api/index.php/v1/content/article<br />
<br />
<translate><br />
==== Get Single Article ==== <!--T:77--><br />
</translate><br />
curl -X GET /api/index.php/v1/content/article/{article_id}<br />
<br />
<translate><br />
==== Delete Article ==== <!--T:78--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/content/article/{article_id}<br />
<br />
<translate><br />
==== Create Article ==== <!--T:79--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/content/article -d <br />
<source lang="javascript"><br />
{<br />
"alias": "my-article",<br />
"articletext": "My text",<br />
"catid": 64,<br />
"language": "*",<br />
"metadesc": "",<br />
"metakey": "",<br />
"title": "Here's an article"<br />
}<br />
</source><br />
<br />
<translate><!--T:80--> Currently the options mentioned here are required properties. However the intention is currently to make AT LEAST metakey and metadesc optional in the API.</translate><br />
<br />
<translate><br />
==== Update Article ==== <!--T:81--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/content/article/{article_id} -d <br />
<source lang="javascript"><br />
{<br />
"catid": 64,<br />
"title": "Updated article"<br />
}<br />
</source><br />
<br />
<br />
<translate><br />
=== Categories === <!--T:82--><br />
</translate><br />
#Route Content Categories is: "v1/content/categories"<br />
#Working with it is similar to [[S:MyLanguage/#Categories|Banners Categories]].<br />
<br />
<translate><br />
<br />
=== Fields Articles === <!--T:83--><br />
</translate><br />
<translate><!--T:84--> #Route Fields Articles is:</translate> "v1/fields/content/articles"<br />
<translate><!--T:85--> #Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Groups Fields Articles === <!--T:86--><br />
</translate><br />
<translate><!--T:87--> #Route Groups Fields Articles is:</translate> "v1/fields/groups/content/articles"<br />
<translate><!--T:88--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Groups Fields Contact]].</translate><br />
<br />
<translate><br />
=== Fields Categories === <!--T:89--><br />
</translate><br />
<translate><!--T:90--> #Route Fields Categories is:</translate> "v1/fields/groups/content/categories"<br />
<translate><!--T:91--> #Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Content History === <!--T:92--><br />
</translate><br />
<translate><!--T:93--> #Route Content History is:</translate> "v1/content/article/contenthistory"<br />
<translate><!--T:94--> #Working with it is similar to [[S:MyLanguage/#Content_History|Banners Content History]].</translate><br />
<br />
<translate><br />
== Languages == <!--T:95--><br />
</translate><br />
<translate><br />
=== Languages === <!--T:96--><br />
</translate><br />
<translate><br />
==== Get List of Languages ==== <!--T:97--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages<br />
<br />
<translate><br />
==== Install Language ==== <!--T:98--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages -d <br />
<source lang="javascript"><br />
{<br />
"package": "pkg_fr-FR"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Content Languages === <!--T:99--><br />
</translate><br />
<translate><br />
==== Get List of Content Languages ==== <!--T:100--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages/content<br />
<br />
<translate><br />
==== Get Single Content Language ==== <!--T:101--><br />
</translate><br />
curl -X GET /api/index.php/v1/v1/languages/content/{language_id}<br />
<br />
<translate><br />
==== Delete Content Language ==== <!--T:102--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/languages/content/{language_id}<br />
<br />
<translate><br />
==== Create Content Language ==== <!--T:103--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/content -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"description": "",<br />
"image": "fr_FR",<br />
"lang_code": "fr-FR",<br />
"metadesc": "",<br />
"metakey": "",<br />
"ordering": 1,<br />
"published": 0,<br />
"sef": "fk",<br />
"sitename": "",<br />
"title": "French (FR)",<br />
"title_native": "Français (France)"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Content Language ==== <!--T:104--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/languages/content/{language_id} -d <br />
<source lang="javascript"><br />
{<br />
"description": "",<br />
"lang_code": "en-GB",<br />
"metadesc": "",<br />
"metakey": "",<br />
"sitename": "",<br />
"title": "English (en-GB)",<br />
"title_native": "English (United Kingdom)"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Overrides Languages === <!--T:105--><br />
</translate><br />
<translate><br />
==== Get List of Overrides Languages Constants ==== <!--T:106--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages/overrides/{app}/{lang_code}<br />
<br />
<translate><br />
==== Get Single Override Language Constant ==== <!--T:107--><br />
</translate><br />
curl -X GET /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id}<br />
<br />
<translate><br />
==== Delete Content Language ==== <!--T:108--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id}<br />
<br />
<translate><br />
==== Create Content Language ==== <!--T:109--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/{app}/{lang_code} -d <br />
<source lang="javascript"><br />
{<br />
"key":"new_key",<br />
"override": "text"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Content Language ==== <!--T:110--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/{app}/{lang_code}/{constant_id} -d <br />
<source lang="javascript"><br />
{<br />
"key":"new_key",<br />
"override": "new text"<br />
}<br />
</source><br />
<br />
var app - enum {"site", "administrator"}<br />
<br />
var lang_code - string Example: “fr-FR“, “en-GB“ you can get lang_code from v1/languages/content<br />
<br />
<translate><br />
==== Search Override Constant ==== <!--T:111--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/search -d <br />
<source lang="javascript"><br />
{<br />
"searchstring": "JLIB_APPLICATION_ERROR_SAVE_FAILED",<br />
"searchtype": "constant"<br />
}<br />
</source><br />
<br />
<translate><!--T:112--> var searchtype - enum {“constant”, “value”}. “constant” search by constant name, “value” - search by constant value</translate><br />
<br />
<translate><br />
==== Refresh Override Search Cache ==== <!--T:113--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/languages/overrides/search/cache/refresh<br />
<br />
<translate><br />
== Menus == <!--T:114--><br />
</translate><br />
<translate><br />
=== Menus === <!--T:115--><br />
</translate><br />
<translate><br />
==== Get List of Menus ==== <!--T:116--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}<br />
<br />
<translate><br />
==== Get Single Menu ==== <!--T:117--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/{menu_id}<br />
<br />
<translate><br />
==== Delete Menu ==== <!--T:118--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/menus/{app}/{menu_id}<br />
<br />
<translate><br />
==== Create Menu ==== <!--T:119--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/menus/{app} -d <br />
<source lang="javascript"><br />
{<br />
"client_id": 0,<br />
"description": "The menu for the site",<br />
"menutype": "menu",<br />
"title": "Menu"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Menu ==== <!--T:120--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/{menu_id} -d <br />
<source lang="javascript"><br />
{<br />
"menutype": "menu",<br />
"title": "New Menu"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Menus Items === <!--T:121--><br />
</translate><br />
<translate><br />
==== Get List of Menus Items Types ==== <!--T:122--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/items/types<br />
<br />
<translate><br />
==== Get List of Menus Items ==== <!--T:123--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/items<br />
<br />
<translate><br />
==== Get Single Menu Item ==== <!--T:124--><br />
</translate><br />
curl -X GET /api/index.php/v1/menus/{app}/items/{menu_item_id}<br />
<br />
<translate><br />
==== Delete Menu Item ==== <!--T:125--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/menus/{app}/items/{menu_item_id}<br />
<br />
<translate><br />
==== Create Menu Item ==== <!--T:126--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/items -d <br />
<source lang="javascript"><br />
{<br />
"access": "1",<br />
"alias": "",<br />
"associations": {<br />
"en-GB": "",<br />
"fr-FR": ""<br />
},<br />
"browserNav": "0",<br />
"component_id": "20",<br />
"home": "0",<br />
"language": "*",<br />
"link": "index.php?option=com_content&view=form&layout=edit",<br />
"menutype": "mainmenu",<br />
"note": "",<br />
"params": {<br />
"cancel_redirect_menuitem": "",<br />
"catid": "",<br />
"custom_cancel_redirect": "0",<br />
"enable_category": "0",<br />
"menu-anchor_css": "",<br />
"menu-anchor_title": "",<br />
"menu-meta_description": "",<br />
"menu-meta_keywords": "",<br />
"menu_image": "",<br />
"menu_image_css": "",<br />
"menu_show": "1",<br />
"menu_text": "1",<br />
"page_heading": "",<br />
"page_title": "",<br />
"pageclass_sfx": "",<br />
"redirect_menuitem": "",<br />
"robots": "",<br />
"show_page_heading": ""<br />
},<br />
"parent_id": "1",<br />
"publish_down": "",<br />
"publish_up": "",<br />
"published": "1",<br />
"template_style_id": "0",<br />
"title": "title",<br />
"toggle_modules_assigned": "1",<br />
"toggle_modules_published": "1",<br />
"type": "component"<br />
}<br />
</source><br />
<br />
<translate><!--T:127--> Example for "Create Article Page"</translate><br />
<br />
<translate><br />
==== Update Menu Item ==== <!--T:128--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/menus/{app}/items/{menu_item_id} -d <br />
<source lang="javascript"><br />
{<br />
"component_id": "20",<br />
"language": "*",<br />
"link": "index.php?option=com_content&view=form&layout=edit",<br />
"menutype": "mainmenu",<br />
"note": "",<br />
"title": "new title",<br />
"type": "component"<br />
}<br />
</source><br />
<br />
<translate><!--T:129--> Example for "Create Article Page"</translate><br />
<br />
<translate><br />
== Messages == <!--T:130--><br />
</translate><br />
<translate><br />
=== Messages === <!--T:131--><br />
</translate><br />
<translate><br />
==== Get List of Messages ==== <!--T:132--><br />
</translate><br />
curl -X GET /api/index.php/v1/messages<br />
<br />
<translate><br />
==== Get Single Message ==== <!--T:133--><br />
</translate><br />
curl -X GET /api/index.php/v1/messages/{message_id}<br />
<br />
<translate><br />
==== Delete Message ==== <!--T:134--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/messages/{message_id}<br />
<br />
<translate><br />
==== Create Message ==== <!--T:135--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/messages -d <br />
<source lang="javascript"><br />
{<br />
"message": "<p>text</p>",<br />
"state": 0,<br />
"subject": "text",<br />
"user_id_from": 773,<br />
"user_id_to": 772<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Message ==== <!--T:136--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/messages/{message_id} -d <br />
<source lang="javascript"><br />
{<br />
"message": "<p>new text</p>",<br />
"subject": "new text",<br />
"user_id_from": 773,<br />
"user_id_to": 772<br />
}<br />
</source><br />
<br />
<translate><br />
== Modules == <!--T:137--><br />
</translate><br />
<translate><br />
=== Modules === <!--T:138--><br />
</translate><br />
<translate><br />
==== Get List of Modules Types ==== <!--T:139--><br />
</translate><br />
curl -X GET /api/index.php/v1/modules/types/{app}<br />
<br />
<translate><br />
==== Get List of Modules ==== <!--T:140--><br />
</translate><br />
curl -X GET /api/index.php/v1/modules/{app}<br />
<br />
<translate><br />
==== Get Single Module ==== <!--T:141--><br />
</translate><br />
curl -X GET /api/index.php/v1/modules/{app}/{module_id}<br />
<br />
<translate><br />
==== Delete Module ==== <!--T:142--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/modules/{app}/{module_id}<br />
<br />
<translate><br />
==== Create Module ==== <!--T:143--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/modules/{app} -d <br />
<source lang="javascript"><br />
{<br />
"access": "1",<br />
"assigned": [<br />
"101",<br />
"105"<br />
],<br />
"assignment": "0",<br />
"client_id": "0",<br />
"language": "*",<br />
"module": "mod_articles_archive",<br />
"note": "",<br />
"ordering": "1",<br />
"params": {<br />
"bootstrap_size": "0",<br />
"cache": "1",<br />
"cache_time": "900",<br />
"cachemode": "static",<br />
"count": "10",<br />
"header_class": "",<br />
"header_tag": "h3",<br />
"layout": "_:default",<br />
"module_tag": "div",<br />
"moduleclass_sfx": "",<br />
"style": "0"<br />
},<br />
"position": "",<br />
"publish_down": "",<br />
"publish_up": "",<br />
"published": "1",<br />
"showtitle": "1",<br />
"title": "Title"<br />
}<br />
</source><br />
<br />
<translate><!--T:144--> Example for "Articles - Archived"</translate><br />
<br />
<translate><br />
==== Update Module ==== <!--T:145--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/modules/{app}/{module_id} -d <br />
<source lang="javascript"><br />
{<br />
"access": "1",<br />
"client_id": "0",<br />
"language": "*",<br />
"module": "mod_articles_archive",<br />
"note": "",<br />
"ordering": "1",<br />
"title": "New Title"<br />
}<br />
</source><br />
<br />
<noinclude>Example for "Articles - Archived"</noinclude><br />
<br />
<translate><br />
== Newsfeeds == <!--T:146--><br />
</translate><br />
<translate><br />
=== Feeds === <!--T:147--><br />
</translate><br />
<translate><br />
==== Get List of Feeds ==== <!--T:148--><br />
</translate><br />
curl -X GET /api/index.php/v1/newsfeeds/feeds<br />
<br />
<translate><br />
==== Get Single Feed ==== <!--T:149--><br />
</translate><br />
curl -X GET /api/index.php/v1/newsfeeds/feeds/{feed_id}<br />
<br />
<translate><br />
==== Delete Feed ==== <!--T:150--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/newsfeeds/feeds/{feed_id}<br />
<br />
<translate><br />
==== Create Feed ==== <!--T:151--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/newsfeeds/feeds -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"alias": "alias",<br />
"catid": 5,<br />
"description": "",<br />
"images": {<br />
"float_first": "",<br />
"float_second": "",<br />
"image_first": "",<br />
"image_first_alt": "",<br />
"image_first_caption": "",<br />
"image_second": "",<br />
"image_second_alt": "",<br />
"image_second_caption": ""<br />
},<br />
"language": "*",<br />
"link": "http://samoylov/joomla/gsoc19_webservices/index.php",<br />
"metadata": {<br />
"hits": "",<br />
"rights": "",<br />
"robots": "",<br />
"tags": {<br />
"tags": "",<br />
"typeAlias": null<br />
}<br />
},<br />
"metadesc": "",<br />
"metakey": "",<br />
"name": "Name",<br />
"ordering": 1,<br />
"params": {<br />
"feed_character_count": "",<br />
"feed_display_order": "",<br />
"newsfeed_layout": "",<br />
"show_feed_description": "",<br />
"show_feed_image": "",<br />
"show_item_description": ""<br />
},<br />
"published": 1<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Feed ==== <!--T:152--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/newsfeeds/feeds/{feed_id} -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"alias": "test2",<br />
"catid": 5,<br />
"description": "",<br />
"link": "http://samoylov/joomla/gsoc19_webservices/index.php",<br />
"metadesc": "",<br />
"metakey": "",<br />
"name": "Test"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Categories === <!--T:153--><br />
</translate><br />
<translate><!--T:154--> #Route Newsfeeds Categories is:</translate> "v1/newsfeeds/categories"<br />
<translate><!--T:155--> #Working with it is similar to [[S:MyLanguage/#Categories|Banners Categories]].</translate><br />
<br />
<translate><br />
== Privacy == <!--T:156--><br />
</translate><br />
<translate><br />
=== Request === <!--T:157--><br />
</translate><br />
<translate><br />
==== Get List of Requests ==== <!--T:158--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/request<br />
<br />
<translate><br />
==== Get Single Request ==== <!--T:159--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/request/{request_id}<br />
<br />
<translate><br />
==== Get Single Request Export Data ==== <!--T:160--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/request/export/{request_id}<br />
<br />
<translate><br />
==== Create Request ==== <!--T:161--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/privacy/request -d <br />
<source lang="javascript"><br />
{<br />
"email":"somenewemail@com.ua",<br />
"request_type":"export"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Consent === <!--T:162--><br />
</translate><br />
<translate><br />
==== Get List of Consents ==== <!--T:163--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/consent<br />
<br />
<translate><br />
==== Get Single Consent ==== <!--T:164--><br />
</translate><br />
curl -X GET /api/index.php/v1/privacy/consent/{consent_id}<br />
<br />
<translate><br />
==== Delete Consent ==== <!--T:165--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/privacy/consent/{consent_id}<br />
<br />
<translate><br />
== Redirect == <!--T:166--><br />
</translate><br />
<translate><br />
=== Redirect === <!--T:167--><br />
</translate><br />
<translate><br />
==== Get List of Redirects ==== <!--T:168--><br />
</translate><br />
curl -X GET /api/index.php/v1/redirect<br />
<br />
<translate><br />
==== Get Single Redirect ==== <!--T:169--><br />
</translate><br />
curl -X GET /api/index.php/v1/redirect/{redirect_id}<br />
<br />
<translate><br />
==== Delete Redirect ==== <!--T:170--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/redirect/{redirect_id}<br />
<br />
<translate><br />
==== Create Redirect ==== <!--T:171--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/redirect -d <br />
<source lang="javascript"><br />
{<br />
"comment": "",<br />
"header": 301,<br />
"hits": 0,<br />
"new_url": "/content/art/99",<br />
"old_url": "/content/art/12",<br />
"published": 1,<br />
"referer": ""<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Redirect ==== <!--T:172--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/redirect/{redirect_id} -d <br />
<source lang="javascript"><br />
{<br />
"new_url": "/content/art/4",<br />
"old_url": "/content/art/132"<br />
}<br />
</source><br />
<br />
<translate><br />
== Tags == <!--T:173--><br />
</translate><br />
<translate><br />
=== Tags === <!--T:174--><br />
</translate><br />
<translate><br />
==== Get List of Tags ==== <!--T:175--><br />
</translate><br />
curl -X GET /api/index.php/v1/tags<br />
<br />
<translate><br />
==== Get Single Tag ==== <!--T:176--><br />
</translate><br />
curl -X GET /api/index.php/v1/tags/{tag_id}<br />
<br />
<translate><br />
==== Delete Tag ==== <!--T:177--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/tags/{tag_id}<br />
<br />
<translate><br />
==== Create Tag ==== <!--T:178--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/tags -d <br />
<source lang="javascript"><br />
{<br />
"access": 1,<br />
"access_title": "Public",<br />
"alias": "test",<br />
"description": "",<br />
"language": "*",<br />
"note": "",<br />
"parent_id": 1,<br />
"path": "test",<br />
"published": 1,<br />
"title": "test"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Tag ==== <!--T:179--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/tags/{tag_id} -d <br />
<source lang="javascript"><br />
{<br />
"alias": "test",<br />
"title": "new title"<br />
}<br />
</source><br />
<br />
<translate><br />
== Templates == <!--T:180--><br />
</translate><br />
<translate><br />
=== Templates Styles === <!--T:181--><br />
</translate><br />
<translate><br />
==== Get List of Templates Styles ==== <!--T:182--><br />
</translate><br />
curl -X GET /api/index.php/v1/templates/styles/{app}<br />
<br />
<translate><br />
==== Get Single Template Style ==== <!--T:183--><br />
</translate><br />
curl -X GET /api/index.php/v1/templates/styles/{app}/{template_style_id}<br />
<br />
<translate><br />
==== Delete Template Style ==== <!--T:184--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/templates/styles/{app}/{template_style_id}<br />
<br />
<translate><br />
==== Create Template Style ==== <!--T:185--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/templates/styles/{app} -d <br />
<source lang="javascript"><br />
{<br />
"home": "0",<br />
"params": {<br />
"fluidContainer": "0",<br />
"logoFile": "",<br />
"sidebarLeftWidth": "3",<br />
"sidebarRightWidth": "3"<br />
},<br />
"template": "cassiopeia",<br />
"title": "cassiopeia - Some Text"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update Template Style ==== <!--T:186--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/templates/styles/{app}/{template_style_id} -d <br />
<source lang="javascript"><br />
{<br />
"template": "cassiopeia",<br />
"title": "new cassiopeia - Default"<br />
}<br />
</source><br />
<br />
<translate><br />
== Users == <!--T:187--><br />
</translate><br />
<translate><br />
=== Users === <!--T:188--><br />
</translate><br />
<translate><br />
==== Get List of Users ==== <!--T:189--><br />
</translate><br />
curl -X GET /api/index.php/v1/users<br />
<br />
<translate><br />
==== Get Single User ==== <!--T:190--><br />
</translate><br />
curl -X GET /api/index.php/v1/users/{user_id}<br />
<br />
<translate><br />
==== Delete User ==== <!--T:191--><br />
</translate><br />
curl -X DELETE /api/index.php/v1/users/{user_id}<br />
<br />
<translate><br />
==== Create User ==== <!--T:192--><br />
</translate><br />
curl -X POST -H "Content-Type: application/json" /api/index.php/v1/users -d <br />
<source lang="javascript"><br />
{<br />
"block": "0",<br />
"email": "test@mail.com",<br />
"groups": [<br />
"2"<br />
],<br />
"id": "0",<br />
"lastResetTime": "",<br />
"lastvisitDate": "",<br />
"name": "nnn",<br />
"params": {<br />
"admin_language": "",<br />
"admin_style": "",<br />
"editor": "",<br />
"helpsite": "",<br />
"language": "",<br />
"timezone": ""<br />
},<br />
"password": "qwerty",<br />
"password2": "qwerty",<br />
"registerDate": "",<br />
"requireReset": "0",<br />
"resetCount": "0",<br />
"sendEmail": "0",<br />
"username": "ad"<br />
}<br />
</source><br />
<br />
<translate><br />
==== Update User ==== <!--T:193--><br />
</translate><br />
curl -X PATCH -H "Content-Type: application/json" /api/index.php/v1/users/{user_id} -d <br />
<source lang="javascript"><br />
{<br />
"email": "new@mail.com",<br />
"groups": [<br />
"2"<br />
],<br />
"name": "name",<br />
"username": "username"<br />
}<br />
</source><br />
<br />
<translate><br />
=== Fields Users === <!--T:194--><br />
</translate><br />
<translate><!--T:195--> #Route Fields Users is:</translate> "v1/fields/users"<br />
<translate><!--T:196--> #Working with it is similar to [[S:MyLanguage/#Fields_Contact|Fields Contact]].</translate><br />
<br />
<translate><br />
=== Groups Fields Users === <!--T:197--><br />
</translate><br />
<translate><!--T:198--> #Route Groups Fields Users is:</translate> "v1/fields/groups/users"<br />
<translate><!--T:199--> #Working with it is similar to [[S:MyLanguage/#Groups_Fields_Contact|Groups Fields Contact]].</translate><br />
<br />
<noinclude><br />
[[Category:Development{{#translation:}}]]<br />
[[Category:Joomla!_4.x{{#translation:}}]]<br />
[[Category:Joomla!_4.0{{#translation:}}]]<br />
[[Category:Joomla!_Api{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679986Creating a custom form field type2020-06-14T13:38:20Z<p>Uglyeoin: /* Setting the values of a List Option and using JSON or an API instead of a database call */</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Setting the values of a List Option and using JSON or an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php<br />
The naming convention is important as it is used within our function name. <br />
<source lang="php"><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"api_site_parameter":"meta.stackoverflow","site_url":"https://meta.stackoverflow.com"~}<br />
// decode the JSON<br />
$sites = json_decode($json, true);<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
$site_url = $site['site_url'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site_url);<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}</source><br />
On the front end simply calling the parameter gets us the value.<br />
<source lang="php"><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</source><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
<br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679985Creating a custom form field type2020-06-14T13:35:28Z<p>Uglyeoin: /* Setting the values of a List Option and using JSON or an API instead of a database call */</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Setting the values of a List Option and using JSON or an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php<br />
The naming convention is important as it is used within our function name. <br />
<source lang="php"><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"items":[{"aliases":["http://www.stackoverflow.com","http://facebook.stackoverflow.com"]~}<br />
// decode the JSON<br />
$sites = json_decode($json, true);<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site);<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}</source><br />
On the front end simply calling the parameter gets us the value.<br />
<source lang="php"><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</source><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
<br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679984Creating a custom form field type2020-06-14T13:27:24Z<p>Uglyeoin: /* Using an API instead of a database call */</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Setting the values of a List Option and using JSON or an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php<br />
The naming convention is important as it is used within our function name. <br />
<source lang="php"><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"items":[{"aliases":["http://www.stackoverflow.com","http://facebook.stackoverflow.com"]~}<br />
// decode the JSON<br />
$sites = json_decode($json, true);<br />
<br />
// set the variable $i so we can iterate over it<br />
$i = 0;<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site);<br />
<br />
// iterate the $i variable so the next loop will choose the next item<br />
$i++;<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}</source><br />
On the front end simply calling the parameter gets us the value.<br />
<source lang="php"><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</source><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
<br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679983Creating a custom form field type2020-06-14T13:26:47Z<p>Uglyeoin: /* Using an API instead of a database call */</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Using an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php<br />
The naming convention is important as it is used within our function name. <br />
<source lang="php"><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"items":[{"aliases":["http://www.stackoverflow.com","http://facebook.stackoverflow.com"]~}<br />
// decode the JSON<br />
$sites = json_decode($json, true);<br />
<br />
// set the variable $i so we can iterate over it<br />
$i = 0;<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site);<br />
<br />
// iterate the $i variable so the next loop will choose the next item<br />
$i++;<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}</source><br />
On the front end simply calling the parameter gets us the value.<br />
<source lang="php"><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</source><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
<br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679982Creating a custom form field type2020-06-14T13:26:07Z<p>Uglyeoin: /* Using an API instead of a database call */</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Using an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php<br />
The naming convention is important as it is used within our function name. <br />
<source lang="php"><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"items":[{"aliases":["http://www.stackoverflow.com","http://facebook.stackoverflow.com"]~}<br />
// decode the JSOn<br />
$sites = json_decode($json, true);<br />
<br />
// set the variable $i so we can iterate over it<br />
$i = 0;<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site);<br />
<br />
// iterate the $i variable so the next loop will choose the next item<br />
$i++;<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}</source><br />
On the front end simply calling the parameter gets us the value.<br />
<source lang="php"><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</source><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
<br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679981Creating a custom form field type2020-06-14T13:25:46Z<p>Uglyeoin: /* Using an API instead of a database call */</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Using an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php* <br />
The naming convention is important as it is used within our function name. <br />
<source lang="php"><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"items":[{"aliases":["http://www.stackoverflow.com","http://facebook.stackoverflow.com"]~}<br />
// decode the JSOn<br />
$sites = json_decode($json, true);<br />
<br />
// set the variable $i so we can iterate over it<br />
$i = 0;<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site);<br />
<br />
// iterate the $i variable so the next loop will choose the next item<br />
$i++;<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}</source><br />
On the front end simply calling the parameter gets us the value.<br />
<source lang="php"><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</source><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
<br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679980Creating a custom form field type2020-06-14T13:25:12Z<p>Uglyeoin: /* Using an API instead of a database call */</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Using an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php* <br />
The naming convention is important as it is used within our function name. <br />
<code><br />
<source lang="php"><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"items":[{"aliases":["http://www.stackoverflow.com","http://facebook.stackoverflow.com"]~}<br />
// decode the JSOn<br />
$sites = json_decode($json, true);<br />
<br />
// set the variable $i so we can iterate over it<br />
$i = 0;<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site);<br />
<br />
// iterate the $i variable so the next loop will choose the next item<br />
$i++;<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}</source><br />
</code><br />
On the front end simply calling the parameter gets us the value.<br />
<code><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</code><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
<br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=Creating_a_custom_form_field_type&diff=679979Creating a custom form field type2020-06-14T13:24:07Z<p>Uglyeoin: Added an example of how to set the options value in a form field list</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<br />
<noinclude>{{Joomla version|version=3.x|comment=<translate><!--T:1--><br />
series</translate>}}</noinclude><br />
{{-}}<br />
{{page|needs review}}<br />
<br />
<translate><br />
<!--T:2--><br />
[https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.Form.html JForm], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [https://api.joomla.org/cms-3/classes/Joomla.CMS.Form.FormField.html JFormField]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].<br />
</translate><br />
<br />
<translate><br />
<!--T:3--><br />
Joomla! makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:<br />
</translate><br />
<br />
<translate><br />
<!--T:4--><br />
* You will be able to mix standard field types with your custom field type in a JForm-based form.<br />
* You will eventually have a reusable code package that can be used easily throughout your code.<br />
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.<br />
</translate><br />
<br />
<translate><br />
== Form field type class requirements == <!--T:5--><br />
</translate><br />
<br />
<translate><br />
<!--T:6--><br />
A form field type is defined in a [[wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least three methods:<br />
</translate><br />
<br />
* <code>public function getLabel()</code><br />
<translate><!--T:7--><br />
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate><br />
* <code>public function getInput()</code><br />
<translate><!--T:8--><br />
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate><br />
* <code>public function getValue()</code><br />
<translate><!--T:9--><br />
*: This function will be called to get the field value. The value is obtained from the function LoadFormData in the Model</translate><br />
<translate><br />
<!--T:10--><br />
Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.<br />
</translate><br />
<br />
<translate><br />
== Which class to subclass? == <!--T:65--><br />
</translate><br />
<br />
<translate><br />
<!--T:11--><br />
For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.<br />
</translate><br />
<br />
<translate><br />
<!--T:12--><br />
'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.<br />
</translate><br />
<br />
<translate><!--T:13--><br />
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate><br />
<br />
<source lang="php"><br />
jimport('joomla.form.helper');<br />
JFormHelper::loadFieldClass('list');<br />
</source><br />
<br />
<translate><!--T:14--><br />
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate><br />
<br />
<translate><br />
== Location of files == <!--T:15--><br />
</translate><br />
<br />
<translate><!--T:16--><br />
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate><br />
<translate><!--T:17--><br />
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate><br />
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source><br />
<translate><!--T:18--><br />
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate><br />
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source><br />
<br />
<translate><br />
== Naming conventions and skeleton == <!--T:19--><br />
</translate><br />
<br />
<translate><!--T:20--><br />
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
class JFormField<FieldName> extends JFormField {<br />
<br />
//The field class must know its own type through the variable $type.<br />
protected $type = '<FieldName>';<br />
<br />
public function getLabel() {<br />
// code that returns HTML that will be shown as the label<br />
}<br />
<br />
public function getInput() {<br />
// code that returns HTML that will be shown as the form field<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
=== Grouping custom field types === <!--T:21--><br />
</translate><br />
<br />
<translate><!--T:22--><br />
'''Warning: this information is partially incorrect and needs to be improved.'''</translate><br />
<br />
<translate><!--T:23--><br />
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate><br />
<br />
<translate><br />
== An example custom field type == <!--T:24--><br />
</translate><br />
<br />
<translate><!--T:25--><br />
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
jimport('joomla.form.formfield');<br />
<br />
class JFormFieldCity extends JFormField {<br />
<br />
protected $type = 'City';<br />
<br />
// getLabel() left out<br />
<br />
public function getInput() {<br />
return '<select id="'.$this->id.'" name="'.$this->name.'">'.<br />
'<option value="1" >New York</option>'.<br />
'<option value="2" >Chicago</option>'.<br />
'<option value="3" >San Francisco</option>'.<br />
'</select>';<br />
}<br />
} <br />
</source><br />
<br />
<translate><br />
<!--T:53--><br />
A more advanced approach is extending the <code>JFormFieldList</code> class. Suppose you want to create a drop-down of cities dynamically from database based on a dynamic condition, then you can do this in the following way:</translate><br />
<br />
<source lang="php"><?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
JFormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$app = JFactory::getApplication();<br />
$country = $app->input->get('country'); //country is the dynamic value which is being used in the view<br />
$db = JFactory::getDbo();<br />
$query = $db->getQuery(true);<br />
$query->select('a.cityname')->from('`#__tablename` AS a')->where('a.country = "'.$country.'" ');<br />
$rows = $db->setQuery($query)->loadObjectlist();<br />
foreach($rows as $row){<br />
$cities[] = $row->cityname;<br />
}<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<translate><!--T:54--><br />
The above example shows a simple query which will show a list of cities from a table where city name belongs to its country respectively. You can create a drop-down based on more complex queries.</translate><br />
<br />
<translate><br />
== Using an API instead of a database call == <br />
</translate><br />
<translate><br />
If you want to use an API call instead of a database call for example to build a custom list item you can use the following code.<br />
<br />
This field was created in a module. To get it to work it needs to be saved to<br />
*mod_modulename/models/fields/stackexchangesites.php* <br />
The naming convention is important as it is used within our function name. <br />
<code><br />
<?php<br />
// Check to ensure this file is included in Joomla!<br />
defined('_JEXEC') or die('Restricted access');<br />
<br />
// call the list field type<br />
JFormHelper::loadFieldClass('list');<br />
<br />
// The class name must always be the same as the filename (in camel case)<br />
// extend the list field type<br />
class JFormFieldStackexchangesites extends JFormFieldList<br />
{<br />
//The field class must know its own type through the variable $type.<br />
protected $type = 'Stackexchangesites';<br />
<br />
// get the options for the list field<br />
public function getOptions()<br />
{<br />
// insert your JSON here or else call an API<br />
$json = {"items":[{"aliases":["http://www.stackoverflow.com","http://facebook.stackoverflow.com"]~}<br />
// decode the JSOn<br />
$sites = json_decode($json, true);<br />
<br />
// set the variable $i so we can iterate over it<br />
$i = 0;<br />
<br />
// use a for each to iterate over the JSON<br />
foreach($sites['items'] as $site)<br />
{<br />
// choose the element of the JSON we want, and set it as a variable so we can use it in our array.<br />
$site = $site['api_site_parameter'];<br />
// set an array and start adding values to it. Set another array within our array to set our value / text items.<br />
$stackExchangesSitesOptions[] = array("value" => $site, "text" => $site);<br />
<br />
// iterate the $i variable so the next loop will choose the next item<br />
$i++;<br />
}<br />
<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $stackExchangesSitesOptions);<br />
return $options;<br />
}<br />
}<br />
</code><br />
On the front end simply calling the parameter gets us the value.<br />
<code><br />
$stackexchangesites = $params->get('stackexchangesites');<br />
</code><br />
</translate><br />
<br />
<translate><br />
=== Pitfalls === <!--T:55--><br />
</translate><br />
<translate><!--T:56--><br />
Loading a custom field can result in a Fatal Error, if a core field exists with the same filename, and the custom field extends the core field.</translate><br />
<br />
<translate><!--T:57--><br />
Consider a file <code>testfields/radio.php</code> containing</translate><br />
<source lang="php"><br />
<?php<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:58--><br />
Calling <code>JFormHelper::loadFieldClass('radio')</code> will yield in a Fatal error: Class 'JFormFieldRadio' not found.</translate><br />
<br />
<translate><!--T:59--><br />
There are two reasons for this.</translate><br />
<br />
<translate><!--T:60--><br />
# JLoader cannot autoload <code>JFormFieldRadio</code>, because the class name (<code>JFormField*</code>) does not match the path name (<code>joomla/form/fields/*</code> - notice the plural on fields).</translate><br />
<translate><!--T:61--><br />
# JFormHelper cannot load <code>JFormFieldRadio</code>, because custom paths are scanned first, and the requested field type('radio') gets resolved before the core classes are reached</translate>.<br />
<br />
<translate><!--T:62--><br />
'''Solution'''</translate><br />
<br />
<translate><!--T:63--><br />
Require the core field file directly:</translate><br />
<br />
<source lang="php"><br />
<?php<br />
require_once JPATH_LIBRARIES . '/joomla/form/fields/radio.php';<br />
<br />
class TestFormFieldRadio extends JFormFieldRadio {}<br />
</source><br />
<br />
<translate><!--T:64--><br />
and use <code>JFormHelper::loadFieldClass</code> properly with 'test.radio' instead of 'radio'.</translate><br />
<br />
<translate><br />
=== Using the custom field type === <!--T:26--><br />
</translate><br />
<translate><br />
==== Linked with a form ==== <!--T:27--><br />
</translate><br />
<translate><!--T:28--><br />
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate><br />
<br />
<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"<br />
description="JFIELD_TITLE_DESC"<br />
required="true" /></source><br />
<br />
<translate><!--T:29--><br />
The attribute name is cAsE-sEnSiTiVe.</translate><br />
<br />
<translate><!--T:30--><br />
In addition, you may need to add the field path to the parent <fieldset>:</translate><br />
<br />
<source lang="xml"><br />
<fieldset addfieldpath="/administrator/components/<component name>/models/fields"><br />
</source><br />
<br />
<translate><br />
==== Not linked with a form ==== <!--T:31--><br />
</translate><br />
<translate><!--T:32--><br />
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate><br />
<br />
<source lang="php"><br />
//Get custom field<br />
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');<br />
$cities = JFormHelper::loadFieldType('City', false);<br />
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!<br />
</source><br />
<br />
<translate><br />
== Overriding <code>getLabel()</code> == <!--T:33--><br />
</translate><br />
<br />
<translate><!--T:34--><br />
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
} </source><br />
<br />
<translate><!--T:35--><br />
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)<br />
<br />
<!--T:36--><br />
If you want to do something completely different, you can of course also override it completely:</translate><br />
<br />
<source lang="php">public function getLabel() {<br />
// Initialize variables.<br />
$label = '';<br />
$replace = '';<br />
<br />
// Get the label text from the XML element, defaulting to the element name.<br />
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];<br />
<br />
// Build the class for the label.<br />
$class = !empty($this->description) ? 'hasTip' : '';<br />
$class = $this->required == true ? $class.' required' : $class;<br />
<br />
// Add replace checkbox<br />
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';<br />
<br />
// Add the opening label tag and main attributes attributes.<br />
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';<br />
<br />
// If a description is specified, use it to build a tooltip.<br />
if (!empty($this->description)) {<br />
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .<br />
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';<br />
}<br />
<br />
// Add the label text and closing tag.<br />
$label .= '>'.$replace.JText::_($text).'</label>';<br />
<br />
return $label; <br />
}</source><br />
<br />
<translate><!--T:37--><br />
This example will add a checkbox inside the label.</translate><br />
<br />
== Sample Component Code ==<br />
Below is the code for a small component which you can install and run, and can adapt to experiment further with custom fields. The component includes 2 custom fields<br />
# a "City" field as described above (except that the options are hard-coded rather than being selected from a database). We'll also allow multiple Cities to be selected, and pre-select two of them as default.<br />
# a custom "time" field which maps to the HTML "time" input type, and includes underlining the label and support for setting a min and max time.<br />
<br />
Create the following 5 files in a folder called com_custom_fields, then zip up this folder to create com_custom_fields.zip, and install this component on your Joomla instance. Once installed, navigate on your browser to your Joomla site, and add to the URL the parameter <tt>&option=com_custom_fields</tt>. This should display the form with the 2 custom fields. You can submit the form and see the HTTP POST parameters using the browser development tools, but the component doesn't contain any code which handles those parameters.<br />
<br />
(As described in [[Basic_form_guide#MVC_and_other_considerations|Basic form guide]], the approach below isn't the recommended way to design Joomla components, but it's written in this minimalistic fashion to focus on the custom fields aspects).<br />
<br />
<tt>com_custom_fields.xml</tt> Manifest file for the component<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension type="component" version="3.1.0" method="upgrade"><br />
<br />
<name>com_custom_fields</name><br />
<version>1.0.0</version><br />
<description>Custom Fields demo component</description><br />
<br />
<administration><br />
</administration><br />
<br />
<files folder="site"><br />
<filename>custom_fields.php</filename><br />
<filename>form_definition.xml</filename><br />
<filename>City.php</filename><br />
<filename>Time.php</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
<tt>custom_fields.php</tt> The main code file which is run when an HTTP GET or POST is directed towards this component. <br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted Access');<br />
<br />
use Joomla\CMS\Form\Form;<br />
<br />
$form = Form::getInstance("sample", __DIR__ . "/form_definition.xml", array("control" => "jform"));<br />
Form::addFieldPath(__DIR__);<br />
?><br />
<form action="<?php echo JRoute::_('index.php?option=com_custom_fields'); ?>"<br />
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data"><br />
<br />
<?php echo $form->renderField('mytime'); ?><br />
<br />
<?php echo $form->renderField('mycity'); ?><br />
<br />
<button type="submit">Submit</button><br />
</form><br />
</source><br />
<br />
<tt>form_definition.xml</tt> File containing the XML for the form definition, basically the 2 custom fields.<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<form name="myForm"><br />
<field<br />
name="mytime"<br />
type="time"<br />
label="Time:"<br />
class="inputbox"<br />
min="09:00"<br />
max="17:30"<br />
required="true" /><br />
<field name="mycity" <br />
type="City"<br />
label="City:"<br />
required="true"<br />
multiple="true"<br />
class="inputbox" /><br />
</form><br />
</source><br />
<br />
<tt>City.php</tt> PHP code for the City custom field.<br />
<source lang="php"><br />
<?php<br />
defined('_JEXEC') or die('Restricted access');<br />
use Joomla\CMS\Form\FormHelper;<br />
<br />
FormHelper::loadFieldClass('list');<br />
<br />
class JFormFieldCity extends JFormFieldList {<br />
<br />
protected $type = 'City';<br />
<br />
public function getOptions() {<br />
$cities = array(<br />
array('value' => 1, 'text' => 'New York'),<br />
array('value' => 2, 'text' => 'Chicago'),<br />
array('value' => 3, 'text' => 'San Francisco'),<br />
);<br />
// Merge any additional options in the XML definition.<br />
$options = array_merge(parent::getOptions(), $cities);<br />
<br />
// pre-select values 2 and 3 by setting the protected $value property<br />
$this->value = array(2, 3);<br />
<br />
return $options;<br />
}<br />
}<br />
</source><br />
<br />
<tt>Time.php</tt> PHP code for the time custom field.<br />
<source lang="php"><br />
<?php<br />
defined('JPATH_PLATFORM') or die;<br />
<br />
use Joomla\CMS\Factory;<br />
use Joomla\CMS\Form\FormField;<br />
<br />
class JFormFieldTime extends FormField<br />
{<br />
protected $type = 'time';<br />
<br />
protected function getInput()<br />
{<br />
// get relevant attributes which were defined in the XML form definition<br />
$attr = !empty($this->class) ? ' class="' . $this->class . '"' : '';<br />
$attr .= !empty($this->element['min']) ? ' min="' . $this->element['min'] . '"' : '';<br />
$attr .= !empty($this->element['max']) ? ' max="' . $this->element['max'] . '"' : '';<br />
<br />
// set up html, including the value and other attributes<br />
$html = '<input type="time" name="' . $this->name . '" value="' . $this->value . '"' . $attr . '/>';<br />
<br />
return $html;<br />
}<br />
<br />
public function getLabel() {<br />
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';<br />
}<br />
}<br />
</source><br />
<br />
<noinclude><br />
<translate><br />
<!--T:52--><br />
[[Category:Development]]<br />
[[Category:Extension development]]<br />
[[Category:Form fields]]<br />
[[Category:Joomla! 2.5]]<br />
[[Category:Joomla! 3.x]]<br />
</translate><br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667963J4.x:Workflow2020-05-23T20:16:30Z<p>Uglyeoin: change states to stages</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|800px]]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''Stages:'' Stages are the start points and end points within a workflow.</translate><br />
* <translate><!--T:13--> ''State:'' The state of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions occur between stages. They are where the actions happen. .</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
<br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow stages (for more info see [[S:MyLanguage/Publishing_Workflow#Stages|Stages]])</translate><br />
* <translate><!--T:31--> Next to the "Stages" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow icon, next to "default", representing the number of existing stages in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one stage to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible stages are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|800px|center|Workflows Plugins]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions. This option is not within the workflows screen. For this option you need to go to Content -> Categories. Once there open any category and you will see a "workflows" tab.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
[[File:Workflow-categories.png|center|800px]]<br />
<br />
<translate><br />
<br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667962J4.x:Workflow2020-05-23T20:15:30Z<p>Uglyeoin: Update states to stages</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|800px]]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''Stages:'' Stages are the start points and end points within a workflow.</translate><br />
* <translate><!--T:13--> ''State:'' The state of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions occur between stages. They are where the actions happen. .</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
<br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow stages (for more info see [[S:MyLanguage/Publishing_Workflow#Stages|Stages]])</translate><br />
* <translate><!--T:31--> Next to the "Stages" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow icon, next to "default", representing the number of existing stages in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|800px|center|Workflows Plugins]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions. This option is not within the workflows screen. For this option you need to go to Content -> Categories. Once there open any category and you will see a "workflows" tab.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
[[File:Workflow-categories.png|center|800px]]<br />
<br />
<translate><br />
<br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667961J4.x:Workflow2020-05-23T20:13:33Z<p>Uglyeoin: Updated States to Stages. Then made conditions states.</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|800px]]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''Stages:'' Stages are the start points and end points within a workflow.</translate><br />
* <translate><!--T:13--> ''State:'' The state of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions occur between stages. They are where the actions happen. .</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
<br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|800px|center|Workflows Plugins]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions. This option is not within the workflows screen. For this option you need to go to Content -> Categories. Once there open any category and you will see a "workflows" tab.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
[[File:Workflow-categories.png|center|800px]]<br />
<br />
<translate><br />
<br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667960J4.x:Workflow2020-05-23T20:11:52Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|800px]]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|800px|center|Workflows Plugins]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions. This option is not within the workflows screen. For this option you need to go to Content -> Categories. Once there open any category and you will see a "workflows" tab.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
[[File:Workflow-categories.png|center|800px]]<br />
<br />
<translate><br />
<br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667959J4.x:Workflow2020-05-23T20:11:01Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|800px]]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|800px|center|Workflows Plugins]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
[[File:Workflow-categories.png|center|800px]]<br />
<br />
<translate><br />
<br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Workflow-categories.png&diff=667958File:Workflow-categories.png2020-05-23T20:10:32Z<p>Uglyeoin: </p>
<hr />
<div>Workflow in the categories menu</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667957J4.x:Workflow2020-05-23T20:09:10Z<p>Uglyeoin: Make workflows plugin image correct width.</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|800px]]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|800px|center|Workflows Plugins]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667956J4.x:Workflow2020-05-23T20:08:15Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|800px]]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|thumb]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667955J4.x:Workflow2020-05-23T20:07:43Z<p>Uglyeoin: Added instructions to disable workflows.</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><!--T:999--> You can disable workflows at any times by visiting "articles" or "workflows" and clicking "options" int he top right. </translate><br />
[[File:Disable-workflows.png|thumb]]<br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|thumb]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Disable-workflows.png&diff=667954File:Disable-workflows.png2020-05-23T20:07:29Z<p>Uglyeoin: </p>
<hr />
<div>How to disable workflows in Joomla!</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667953J4.x:Workflow2020-05-23T20:03:43Z<p>Uglyeoin: Insert section about workflow plugins.</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
* <translate><!--T:53--> All of the workflow transition actions are Joomla! workflow plugins. If you go to System -> Plugins. Then change the "type" dropdown to "workflow" you will see the plugins. These can be disabled like any other plugin. </translate> <br />
<br />
[[File:Workflows--plugins--workflows.png|thumb]]<br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Workflows--plugins--workflows.png&diff=667952File:Workflows--plugins--workflows.png2020-05-23T20:03:29Z<p>Uglyeoin: </p>
<hr />
<div>The Workflow plugins</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667951J4.x:Workflow2020-05-23T19:59:15Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
<translate><!--T:51--> The final tab is the permissions tab. This allows you to set who can use this transition. </translate><br />
<br />
* <translate><!--T:52--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667950J4.x:Workflow2020-05-23T19:58:06Z<p>Uglyeoin: Multiple changes to content and images</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|800px|center|Edit Transition Actions]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
<translate><!--T:50--> Finally there is the "more receivers" option. This allows you to choose individual users to receive this notification. </translate><br />
<br />
[[File:Transitions--edit--notification.png|800px|center|Edit Transition Notification]]<br />
<br />
* <translate><!--T:51--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667949J4.x:Workflow2020-05-23T19:56:47Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|thumb]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
<translate><!--T:48--> You can also add additional message text. This will also allow you to use a [[J3.x:Language_Overrides_in_Joomla|language]] string which would make the message text translatable. </translate><br />
<br />
<translate><!--T:49--> The Usergroups option will allow you to define who will receive the notification. In the example we have chosen we would choose ''editor'' as the usergroup. In that example all users within that usergroup would get a notification. </translate><br />
<br />
* <translate><!--T:51--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667948J4.x:Workflow2020-05-23T19:56:09Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:46--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
[[File:Transitions--edit--transition-actions.png|thumb]]<br />
<br />
<translate><!--T:47--> The ''transition notifications'' tab allows you to define whether a notification is sent during that state. For example if an article has been written but needs to be proofread, you could send an email notification to the editor </translate><br />
<br />
* <translate><!--T:51--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667947J4.x:Workflow2020-05-23T19:55:25Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
<translate><!--T:45--> The ''transition actions'' stage allows you to define what state the item will be in after the transition is complete. For example if the item is an article it could become unpublished, which is exactly what happens in the ''unpublish'' transition. You can also define whether the item is featured or not by the end of the state. </translate><br />
<br />
* <translate><!--T:47--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667946J4.x:Workflow2020-05-23T19:54:16Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Transitions--edit--description.png|800px|center|Edit Transitions View]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667945J4.x:Workflow2020-05-23T19:54:01Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
<translate><!--T:45--> The ''target stage'' is the stage the workflow will end up at after the transition has taken place. </translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667944J4.x:Workflow2020-05-23T19:53:31Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<translate><!--T:44--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage. </translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667943J4.x:Workflow2020-05-23T19:52:21Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue icon. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
<br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667942J4.x:Workflow2020-05-23T19:51:29Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667941J4.x:Workflow2020-05-23T19:49:21Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The ''current stage'' will define where this transition is applied. You can choose all stages, or a specific stage.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Transitions--edit--notification.png&diff=667940File:Transitions--edit--notification.png2020-05-23T19:14:20Z<p>Uglyeoin: </p>
<hr />
<div>Transitions - Edit - the Notifications Tab</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Transitions--edit--transition-actions.png&diff=667939File:Transitions--edit--transition-actions.png2020-05-23T19:02:28Z<p>Uglyeoin: </p>
<hr />
<div>Edit Transitions -- transitions actions tab</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Transitions--edit--description.png&diff=667938File:Transitions--edit--description.png2020-05-23T18:53:04Z<p>Uglyeoin: </p>
<hr />
<div>The transition edit window</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Transitions-View.png&diff=667937File:Transitions-View.png2020-05-23T18:49:23Z<p>Uglyeoin: </p>
<hr />
<div>The transitions view</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667936J4.x:Workflow2020-05-23T18:45:10Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages. You can edit the name of a stage by clicking on it. </translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667935J4.x:Workflow2020-05-23T18:44:12Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==Stages== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages.</translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667934J4.x:Workflow2020-05-23T18:43:57Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==States== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The stages are accessed via the "Workflows List" container via clicking on the yellow icon showing the number of stages.</translate><br />
<br />
<br />
[[File:Stages.png|800px|center|Stages View]]<br />
<br />
[[File:Stages--edit.png|800px|center|The Edit Stage view]]<br />
<br />
* <translate><!--T:39--> In the second picture you can edit the stage. You can enable or disable it and write a note. It also has a "default" toggle. If there is only one item you will not be able to toggle this.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667933J4.x:Workflow2020-05-23T18:43:01Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==States== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The states can be accessed through the "Workflows List" container via clicking on ''Manage'' states. You can set a default state (which must be of the condition "published"). When clicking on the title, you can ''Edit'' the state.</translate><br />
<br />
[[File:States List-<translate><!--T:37--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
[[File:Edit State-<translate><!--T:38--> en</translate>.png|800px|center|Edit State]]<br />
<br />
* <translate><!--T:39--> In the second picture you find a status option to the right. This is the condition of the state.</translate><br />
* <translate><!--T:40--> To the left there is a "Condition of items in this State" dropdown. This concerns the status of the items (e.g. articles) which are currently in this state.</translate><br />
** <translate><!--T:41--> ''Example:'' A possible sequence of states would be: Unpublished {{rarr}} In Review {{rarr}}Published.</translate><br />
<br />
<translate><br />
<br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Stages--edit.png&diff=667932File:Stages--edit.png2020-05-23T18:36:12Z<p>Uglyeoin: </p>
<hr />
<div>The edit stage view</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Stages.png&diff=667931File:Stages.png2020-05-23T18:35:26Z<p>Uglyeoin: </p>
<hr />
<div>The stages view</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667930J4.x:Workflow2020-05-23T18:33:15Z<p>Uglyeoin: Grammar correction</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally tidier. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==States== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The states can be accessed through the "Workflows List" container via clicking on ''Manage'' states. You can set a default state (which must be of the condition "published"). When clicking on the title, you can ''Edit'' the state.</translate><br />
<br />
[[File:States List-<translate><!--T:37--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
[[File:Edit State-<translate><!--T:38--> en</translate>.png|800px|center|Edit State]]<br />
<br />
* <translate><!--T:39--> In the second picture you find a status option to the right. This is the condition of the state.</translate><br />
* <translate><!--T:40--> To the left there is a "Condition of items in this State" dropdown. This concerns the status of the items (e.g. articles) which are currently in this state.</translate><br />
** <translate><!--T:41--> ''Example:'' A possible sequence of states would be: Unpublished {{rarr}} In Review {{rarr}}Published.</translate><br />
<br />
<translate><br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667929J4.x:Workflow2020-05-23T18:32:07Z<p>Uglyeoin: Remove inaccurate information</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally more tidy. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow square icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> You can also see the workflow ID.</translate><br />
<br />
<translate><br />
<br />
==States== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The states can be accessed through the "Workflows List" container via clicking on ''Manage'' states. You can set a default state (which must be of the condition "published"). When clicking on the title, you can ''Edit'' the state.</translate><br />
<br />
[[File:States List-<translate><!--T:37--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
[[File:Edit State-<translate><!--T:38--> en</translate>.png|800px|center|Edit State]]<br />
<br />
* <translate><!--T:39--> In the second picture you find a status option to the right. This is the condition of the state.</translate><br />
* <translate><!--T:40--> To the left there is a "Condition of items in this State" dropdown. This concerns the status of the items (e.g. articles) which are currently in this state.</translate><br />
** <translate><!--T:41--> ''Example:'' A possible sequence of states would be: Unpublished {{rarr}} In Review {{rarr}}Published.</translate><br />
<br />
<translate><br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667926J4.x:Workflow2020-05-23T16:30:03Z<p>Uglyeoin: Updated Workflows Screenshot</p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally more tidy. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows-en.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow circle icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> Furthermore you see the date the workflow was created, the author and an ID.</translate><br />
<br />
<translate><br />
<br />
==States== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The states can be accessed through the "Workflows List" container via clicking on ''Manage'' states. You can set a default state (which must be of the condition "published"). When clicking on the title, you can ''Edit'' the state.</translate><br />
<br />
[[File:States List-<translate><!--T:37--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
[[File:Edit State-<translate><!--T:38--> en</translate>.png|800px|center|Edit State]]<br />
<br />
* <translate><!--T:39--> In the second picture you find a status option to the right. This is the condition of the state.</translate><br />
* <translate><!--T:40--> To the left there is a "Condition of items in this State" dropdown. This concerns the status of the items (e.g. articles) which are currently in this state.</translate><br />
** <translate><!--T:41--> ''Example:'' A possible sequence of states would be: Unpublished {{rarr}} In Review {{rarr}}Published.</translate><br />
<br />
<translate><br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=File:Workflows-en.png&diff=667925File:Workflows-en.png2020-05-23T16:28:01Z<p>Uglyeoin: </p>
<hr />
<div>com_worksflows initial page</div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667924J4.x:Workflow2020-05-23T15:47:37Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally more tidy. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows List-<translate><!--T:26--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow circle icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> Furthermore you see the date the workflow was created, the author and an ID.</translate><br />
<br />
<translate><br />
==States== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The states can be accessed through the "Workflows List" container via clicking on ''Manage'' states. You can set a default state (which must be of the condition "published"). When clicking on the title, you can ''Edit'' the state.</translate><br />
<br />
[[File:States List-<translate><!--T:37--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
[[File:Edit State-<translate><!--T:38--> en</translate>.png|800px|center|Edit State]]<br />
<br />
* <translate><!--T:39--> In the second picture you find a status option to the right. This is the condition of the state.</translate><br />
* <translate><!--T:40--> To the left there is a "Condition of items in this State" dropdown. This concerns the status of the items (e.g. articles) which are currently in this state.</translate><br />
** <translate><!--T:41--> ''Example:'' A possible sequence of states would be: Unpublished {{rarr}} In Review {{rarr}}Published.</translate><br />
<br />
<translate><br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoinhttps://docs.sandbox.joomla.org/index.php?title=J4.x:Workflow&diff=667923J4.x:Workflow2020-05-23T15:47:13Z<p>Uglyeoin: </p>
<hr />
<div><noinclude><languages /></noinclude><br />
<noinclude>{{Joomla version|version=4.x}}</noinclude><br />
{{-}}<br />
<translate><br />
==Introduction== <!--T:1--><br />
</translate><br />
<translate><!--T:2--> The Publishing Workflow component is used to replace static states (unpublished, published, trashed and archived) with a more generic approach. This way you can easily create a customized workflow to manage your articles within a component.</translate> <br />
<br />
*<translate><!--T:3--> The article backend view in Joomla3.x:</translate><br />
[[File:Article view 3-<translate><!--T:4--> en</translate>.png|800px|center]]<br />
*<translate><!--T:5--> The article backend view in Joomla 4.x:</translate><br />
[[File:J4 Articles Backend.png|800px]]<br />
<br />
<translate><!--T:7--> The article tool range is now smaller and the view generally more tidy. You can create customized states for the articles and group them in categories.</translate><br />
<br />
<translate><!--T:8--> There is a tutorial page containing steps for the creation of your first workflow: [[S:MyLanguage/Publishing Workflow/Scenarios|Scenarios]].</translate><br /><br />
<translate><br />
<!--T:9--><br />
You can find more information about the implementation of the component in other areas on the page of the Google Summer of Code project DOC: [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]</translate><br />
<br />
<translate><br />
<br />
==Terms & Definitions== <!--T:10--><br />
</translate><br />
* <translate><!--T:11--> ''Workflows:'' You can create several workflows. Each workflow contains states, possible transitions and item conditions.</translate><br />
* <translate><!--T:12--> ''States:'' States can be regarded as steps within a workflow.</translate><br />
* <translate><!--T:13--> ''Conditions:'' The condition of an item can be unpublished, published, trashed or archived.</translate><br />
* <translate><!--T:14--> ''Transitions:'' Transitions set the sequence of states an article has to pass.</translate><br />
* <translate><!--T:15--> ''Categories:'' Articles can be assigned to categories.</translate><br />
<br />
<translate><br />
==Usage of the toolbar== <!--T:16--><br />
</translate><br />
<translate><!--T:17--> In the toolbar you find several buttons. You can select an item via the checkbox at the left of the title. At least one item must be selected to complete one of the following actions:</translate><br />
* <translate><!--T:18--> Publish or unpublish items</translate> <br />
* <translate><!--T:19--> Set an item to default</translate><br />
* <translate><!--T:20--> Item Check-In</translate><br />
** <translate><!--T:21--> While a user is editing an item, the items edit functionality will be locked for other users during that period of time. The check-in function unlocks the item. '''Please keep in mind:''' Make sure that the edit process has been completed and saved before you unlock the item. Otherwise previously made changes could be lost.</translate><br />
* <translate><!--T:22--> Trash Items</translate> <br />
** <translate><!--T:23--> '''Please keep in mind:''' Through the usage of the trash button you are only '''''moving items to trash'''''. This means the items status is being set to "trashed". In order to '''''delete an item completely''''', you have to use the search tools and filter for the status "trashed". In the displayed list of items, select the item you wish to be permanently deleted and click the trash button again.</translate><br />
<br />
<translate><br />
==Workflows== <!--T:24--><br />
</translate><br />
<translate><!--T:25--> The workflow resembles a sequence of steps. It can be accessed via the main top menu under "Content". You will be directed to the "Workflows List", an overview of all your existing workflows. A workflow contains several states of different conditions. Items (e.g. articles) can transit through those states.</translate> <br />
<br />
[[File:Workflows List-<translate><!--T:26--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
* <translate><!--T:27--> You see the status of the workflow (published / unpublished)</translate><br />
* <translate><!--T:28--> Next to the status is the title. By clicking on the title you can ''edit the workflow''</translate><br />
** <translate><!--T:29--> ''Editable'': Title | Description | Status | Default Option | Permissions (Rights Management)</translate><br />
* <translate><!--T:30--> Next to the title you find the option to ''Manage'' the workflow states (for more info see [[S:MyLanguage/Publishing_Workflow#States|States]])</translate><br />
* <translate><!--T:31--> Next to the "States" is the default option</translate><br />
* <translate><!--T:32--> You find a yellow circle icon, next to "default", representing the number of existing states in this workflow</translate><br />
* <translate><!--T:33--> Next to the yellow circle is a blue arrow icon that represents the number of existing transitions in this workflow (for more info see[[S:MyLanguage/Publishing_Workflow#Transitions| Transitions]])</translate><br />
* <translate><!--T:34--> Furthermore you see the date the workflow was created, the author and an ID.</translate><br />
<br />
<translate><br />
==States== <!--T:35--><br />
</translate><br />
<translate><!--T:36--> The states can be accessed through the "Workflows List" container via clicking on ''Manage'' states. You can set a default state (which must be of the condition "published"). When clicking on the title, you can ''Edit'' the state.</translate><br />
<br />
[[File:States List-<translate><!--T:37--> en</translate>.png|800px|center|Workflows List]]<br />
<br />
[[File:Edit State-<translate><!--T:38--> en</translate>.png|800px|center|Edit State]]<br />
<br />
* <translate><!--T:39--> In the second picture you find a status option to the right. This is the condition of the state.</translate><br />
* <translate><!--T:40--> To the left there is a "Condition of items in this State" dropdown. This concerns the status of the items (e.g. articles) which are currently in this state.</translate><br />
** <translate><!--T:41--> ''Example:'' A possible sequence of states would be: Unpublished {{rarr}} In Review {{rarr}}Published.</translate><br />
<br />
<translate><br />
==Transitions== <!--T:42--><br />
</translate><br />
<translate><!--T:43--> Articles can transit from one state to another. The transitions can be managed through the "Workflows List" container via clicking on the blue arrow icon or via the menu on the left, after clicking on ''Manage'' states. You can set several transitions that items can go through. The possible states are based on the ones you have created for this specific workflow.</translate><br />
<br />
[[File:Edit Transition-<translate><!--T:44--> en</translate>.png|800px|center|Edit Transition]]<br />
<br />
* <translate><!--T:45--> ''Example:'' In the transition "Next Step: Publishing" items are originally of the state "unpublished". They are, for example, in need of a review. After they have been reviewed, they can transit to the state "published".</translate> <br />
<br />
<translate><br />
==Categories== <!--T:46--><br />
</translate><br />
<translate><!--T:47--> Articles can be assigned to categories. They correspond to a certain workflow and can be customized in various ways. You can set a status, parent category and also restrict the access as well as the permissions.</translate> <br />
* <translate><!--T:48--> ''Example:'' You have certain articles that you want to be available only for administrators or users of a higher rank. You can call your category "Restricted" and set all permissions on "Allowed" for administrators or higher. This way you do not have to set those permissions for every article concerned but can move them into this special category and save time instead.</translate><br />
<br />
<translate><br />
==Related Information== <!--T:49--><br />
</translate><br />
<translate><!--T:50--> See also:</translate><br />
<translate><!--T:51--><br />
* [[S:MyLanguage/Publishing_Workflow_Implementation|Publishing Workflow Implementation]]<br />
* [[S:MyLanguage/Publishing_Workflow/Scenarios|Scenarios]]</translate><br />
<br />
<noinclude><br />
[[Category:Joomla! 4.x{{#translation:}}]]<br />
[[Category:Tutorials{{#translation:}}]]<br />
[[Category:Article Management{{#translation:}}]]<br />
</noinclude></div>Uglyeoin